/usr/share/emacs/site-lisp/bbdb3/bbdb.el is in bbdb3 3.1.2-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 | ;;; bbdb.el --- core of BBDB
;; Copyright (C) 1991, 1992, 1993, 1994 Jamie Zawinski <jwz@netscape.com>.
;; Copyright (C) 2010-2015 Roland Winkler <winkler@gnu.org>
;; This file is part of the Insidious Big Brother Database (aka BBDB),
;; BBDB is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; BBDB is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with BBDB. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;; This file is the core of the Insidious Big Brother Database (aka BBDB),
;;; See the BBDB info manual for documentation.
;;;
;;; -----------------------------------------------------------------------
;;; | There is a mailing list for discussion of BBDB: |
;;; | bbdb-info@lists.sourceforge.net |
;;; | To join, send mail to bbdb-info-request@lists.sourceforge.net |
;;; | (do not forget the "-request" part or you'll look silly in front of |
;;; | lots of people who have the ability to remember it indefinitely...) |
;;; | |
;;; | When joining this list or reporting bugs, please mention which |
;;; | version of BBDB you have. |
;;; -----------------------------------------------------------------------
;;; Code:
(require 'timezone)
(require 'bbdb-site)
;; When running BBDB, we have (require 'bbdb-autoloads)
(eval-when-compile ; pacify the compiler.
(autoload 'widget-group-match "wid-edit")
(autoload 'bbdb-migrate "bbdb-migrate")
(autoload 'bbdb-do-records "bbdb-com")
(autoload 'bbdb-append-display-p "bbdb-com")
(autoload 'bbdb-toggle-records-layout "bbdb-com")
(autoload 'bbdb-dwim-mail "bbdb-com")
(autoload 'bbdb-layout-prefix "bbdb-com")
(autoload 'bbdb-completing-read-records "bbdb-com")
(autoload 'mail-position-on-field "sendmail")
(autoload 'vm-select-folder-buffer "vm-folder")
;; cannot use autoload for variables...
(defvar message-mode-map) ;; message.el
(defvar mail-mode-map) ;; sendmail.el
(defvar gnus-article-buffer)) ;; gnus-art.el
;; Custom groups
(defgroup bbdb nil
"The Insidious Big Brother Database."
:group 'news
:group 'mail)
(defgroup bbdb-record-display nil
"Variables that affect the display of BBDB records"
:group 'bbdb)
(defgroup bbdb-record-edit nil
"Variables that affect the editing of BBDB records"
:group 'bbdb)
(defgroup bbdb-sendmail nil
"Variables that affect sending mail."
:group 'bbdb)
(defgroup bbdb-mua nil
"Variables that specify the BBDB-MUA interface"
:group 'bbdb)
(defgroup bbdb-mua-gnus nil
"Gnus-specific BBDB customizations"
:group 'bbdb-mua)
(put 'bbdb-mua-gnus 'custom-loads '(bbdb-gnus))
(defgroup bbdb-mua-gnus-scoring nil
"Gnus-specific scoring BBDB customizations"
:group 'bbdb-mua-gnus)
(put 'bbdb-mua-gnus-scoring 'custom-loads '(bbdb-gnus))
(defgroup bbdb-mua-gnus-splitting nil
"Gnus-specific splitting BBDB customizations"
:group 'bbdb-mua-gnus)
(put 'bbdb-mua-gnus-splitting 'custom-loads '(bbdb-gnus))
(defgroup bbdb-mua-vm nil
"VM-specific BBDB customizations"
:group 'bbdb-mua)
(put 'bbdb-mua-vm 'custom-loads '(bbdb-vm))
(defgroup bbdb-mua-message nil
"Message-specific BBDB customizations"
:group 'bbdb-mua)
(put 'bbdb-mua-message 'custom-loads '(bbdb-message))
(defgroup bbdb-utilities nil
"Customizations for BBDB Utilities"
:group 'bbdb)
(defgroup bbdb-utilities-dialing nil
"BBDB Customizations for phone number dialing"
:group 'bbdb)
(defgroup bbdb-utilities-print nil
"Customizations for printing the BBDB."
:group 'bbdb)
(put 'bbdb-utilities-print 'custom-loads '(bbdb-print))
(defgroup bbdb-utilities-anniv nil
"Customizations for BBDB Anniversaries"
:group 'bbdb-utilities)
(put 'bbdb-utilities-anniv 'custom-loads '(bbdb-anniv))
(defgroup bbdb-utilities-ispell nil
"Customizations for BBDB ispell interface"
:group 'bbdb-utilities)
(put 'bbdb-utilities-ispell 'custom-loads '(bbdb-ispell))
(defgroup bbdb-utilities-snarf nil
"Customizations for BBDB snarf"
:group 'bbdb-utilities)
(put 'bbdb-utilities-snarf 'custom-loads '(bbdb-snarf))
(defgroup bbdb-utilities-pgp nil
"Customizations for BBDB pgp"
:group 'bbdb-utilities)
(put 'bbdb-utilities-pgp 'custom-loads '(bbdb-pgp))
(defgroup bbdb-utilities-sc nil
"Customizations for using Supercite with the BBDB."
:group 'bbdb-utilities
:prefix "bbdb-sc")
(put 'bbdb-utilities-sc 'custom-loads '(bbdb-sc))
;;; Customizable variables
(defcustom bbdb-file (locate-user-emacs-file "bbdb" ".bbdb")
"The name of the Insidious Big Brother Database file."
:group 'bbdb
:type 'file)
;; This should be removed, and the following put in place:
;; a hierarchical structure of bbdb files, some perhaps read-only,
;; perhaps caching in the local bbdb. This way one could have, e.g. an
;; organization address book, with each person having access to it, and
;; then a local address book with personal stuff in it.
(defcustom bbdb-file-remote nil
"The remote file to save the BBDB database to.
When this is non-nil, it should be a file name.
When BBDB reads `bbdb-file', it also checks this file,
and if it is newer than `bbdb-file', it loads this file.
When BBDB writes `bbdb-file', it also writes this file.
This feature allows one to keep the database in one place while using
different computers, thus reducing the need for merging different files."
:group 'bbdb
:type '(choice (const :tag "none" nil)
(file :tag "remote file name")))
(defcustom bbdb-file-remote-save-always t
"If t `bbdb-file-remote' is saved automatically when `bbdb-file' is saved.
When nil, ask."
:group 'bbdb
:type 'boolean)
(defcustom bbdb-read-only nil
"If t then BBDB will not modify `bbdb-file'.
If you have more than one Emacs running at the same time, you might want
to set this to t in all but one of them."
:group 'bbdb
:type '(choice (const :tag "Database is read-only" t)
(const :tag "Database is writable" nil)))
(defcustom bbdb-auto-revert nil
"If t revert unchanged database without querying.
If t and `bbdb-file' has changed on disk, while the database
has not been modified inside Emacs, revert the database automatically.
If nil or the database has been changed inside Emacs, always query
before reverting."
:group 'bbdb
:type '(choice (const :tag "Revert unchanged database without querying" t)
(const :tag "Ask before reverting database")))
(defcustom bbdb-check-auto-save-file nil
"If t BBDB will check its auto-save file.
If this file is newer than `bbdb-file', BBDB will offer to revert."
:group 'bbdb
:type '(choice (const :tag "Check auto-save file" t)
(const :tag "Do not check auto-save file" nil)))
(defcustom bbdb-before-save-hook nil
"Hook run before saving `bbdb-file'."
:group 'bbdb
:type 'hook)
(defcustom bbdb-after-save-hook nil
"Hook run after saving `bbdb-file'."
:group 'bbdb
:type 'hook)
;; The default element of `bbdb-create-hook' is `bbdb-creation-date'.
;; The default element of `bbdb-change-hook' is `bbdb-timestamp'.
;; -- We have a problem here:
;; Usually, hook variables are not set, but functions are added
;; by calling `add-hook' and removed by calling `remove-hook'.
;; If the user calls `add-hook' in the init file (usually before loading
;; the package that defines the hook variable), this also initializes
;; the respective hook variable. Yet this collides with a non-nil
;; default value of a hook variable because a non-nil INITVALUE for `defvar'
;; or `defcustom' has no effect if a variable is already bound.
;; Therefore, the following code calls `add-hook' unconditionally.
;; Yet this is not a perfect solution either for two reasons.
;; First, `defcustom' gets confused if the default is set outside `defcustom'.
;; So we use `defvar', though these are really user variables.
;; Second, if the user wants to remove the default functions from the
;; respective hooks, the current solution requires that he or she calls
;; `remove-hook' *after* loading bbdb.el. However, it is more likely that
;; users call `add-hook' on these variables in their init files than calling
;; `remove-hook'. In that sense, the following should work for most people.
;; Nonetheless, suggestions for better solutions are appreciated!
(defvar bbdb-create-hook nil
"*Hook run each time a new BBDB record is created.
Run with one argument, the new record. This is called before the record is
added to the database, followed by a call of `bbdb-change-hook'.
If a record has been created by analyzing a mail message, hook functions
can use the variable `bbdb-update-records-address' to determine the header
and class of the mail address according to `bbdb-message-headers'.")
(add-hook 'bbdb-create-hook 'bbdb-creation-date)
(defvar bbdb-change-hook nil
"*Hook run each time a BBDB record is changed.
Run with one argument, the record. This is called before the database
is modified. If a new bbdb record is created, `bbdb-create-hook' is called
first, followed by a call of this hook.")
(add-hook 'bbdb-change-hook 'bbdb-timestamp)
(defcustom bbdb-time-stamp-format "%Y-%m-%d %T %z"
"The BBDB time stamp format. See `format-time-string'.
This function is called with arg UNIVERSAL being non-nil."
:group 'bbdb
:type 'string)
(defcustom bbdb-after-change-hook nil
"Hook run each time a BBDB record is changed.
Run with one argument, the record. This is called after the database
is modified. So if you want to modify a record when it is created or changed,
use instead `bbdb-create-hook' and / or `bbdb-change-hook'."
:group 'bbdb
:type 'hook)
(defcustom bbdb-after-read-db-hook nil
"Hook run (with no arguments) after `bbdb-file' is read.
Note that this can be called more than once if the BBDB is reverted."
:group 'bbdb
:type 'hook)
(defcustom bbdb-initialize-hook nil
"Normal hook run after the BBDB initialization function `bbdb-initialize'."
:group 'bbdb
:type 'hook)
(defcustom bbdb-mode-hook nil
"Normal hook run when the *BBDB* buffer is created."
:group 'bbdb
:type 'hook)
(defcustom bbdb-silent nil
"If t, BBDB suppresses all its informational messages and queries.
Be very very certain you want to set this to t, because it will suppress
queries to alter record names, assign names to addresses, etc.
Lisp Hackers: See also `bbdb-silent-internal'."
:group 'bbdb
:type '(choice (const :tag "Run silently" t)
(const :tag "Disable silent running" nil)))
(defcustom bbdb-info-file nil
"Location of the bbdb info file, if it's not in the standard place."
:group 'bbdb
:type '(choice (const :tag "Standard location" nil)
(file :tag "Nonstandard location")))
;;; Record display
(defcustom bbdb-pop-up-window-size 0.5
"Vertical size of BBDB window (vertical split).
If it is an integer number, it is the number of lines used by BBDB.
If it is a fraction between 0.0 and 1.0 (inclusive), it is the fraction
of the tallest existing window that BBDB will take over.
If it is t use `display-buffer'/`pop-to-buffer' to create the BBDB window.
See also `bbdb-mua-pop-up-window-size'."
:group 'bbdb-record-display
:type '(choice (number :tag "BBDB window size")
(const :tag "Use `pop-to-buffer'" t)))
(defcustom bbdb-dedicated-window nil
"Make *BBDB* window a dedicated window.
Allowed values include nil (not dedicated) 'bbdb (weakly dedicated)
and t (strongly dedicated)."
:group 'bbdb-record-display
:type '(choice (const :tag "BBDB window not dedicated" nil)
(const :tag "BBDB window weakly dedicated" 'bbdb)
(const :tag "BBDB window strongly dedicated" t)))
(defcustom bbdb-layout-alist
'((one-line (order . (phone mail-alias mail notes))
(name-end . 24)
(toggle . t))
(multi-line (omit . (creation-date timestamp
name-format name-face))
(toggle . t)
(indentation . 21))
(pop-up-multi-line (omit . (creation-date timestamp
name-format name-face))
(indentation . 21))
(full-multi-line (indentation . 21)))
"Alist describing each display layout.
The format of an element is (LAYOUT-NAME OPTION-ALIST).
By default there are four different layout types used by BBDB, which are
`one-line', `multi-line', `pop-up-multi-line' (used for pop-ups) and
`full-multi-line' (showing all fields of a record).
OPTION-ALIST specifies the options for the layout. Valid options are:
------- Availability --------
Format one-line multi-line default if unset
------------------------------------------------------------------------------
(toggle . BOOL) + + nil
(order . FIELD-LIST) + + '(phone ...)
(omit . FIELD-LIST) + + nil
(name-end . INTEGER) + - 40
(indentation . INTEGER) - + 21
(primary . BOOL) - + nil
(display-p . FUNCTION) + + nil
- toggle: controls if this layout is included when toggeling the layout
- order: defines a user specific order for the fields, where t is a place
holder for all remaining fields
- omit: is a list of xfields which should not be displayed
or t to exclude all xfields except those listed in the order option
- name-end: sets the column where the name should end in one-line layout.
- indentation: sets the level of indentation for multi-line display.
- primary: controls whether only the primary mail is shown or all are shown.
- display-p: a function controlling whether the record is to be displayed.
When you add a new layout FOO, you can write a corresponding layout
function `bbdb-display-record-layout-FOO'. If you do not write your own
layout function, the multi-line layout will be used."
:group 'bbdb-record-display
:type
`(repeat
(cons :tag "Layout Definition"
(choice :tag "Layout type"
(const one-line)
(const multi-line)
(const pop-up-multi-line)
(const full-multi-line)
(symbol))
(set :tag "Properties"
(cons :tag "Order"
(const :tag "List of fields to order by" order)
(repeat (choice (const phone)
(const address)
(const mail)
(const AKA)
(const notes)
(symbol :tag "other")
(const :tag "Remaining fields" t))))
(choice :tag "Omit"
:value (omit . nil)
(cons :tag "List of fields to omit"
(const :tag "Fields not to display" omit)
(repeat (choice (const phone)
(const address)
(const mail)
(const AKA)
(const notes)
(symbol :tag "other"))))
(const :tag "Exclude all fields except those listed in the order note" t))
(cons :tag "Indentation"
:value (indentation . 14)
(const :tag "Level of indentation for multi-line layout"
indentation)
(number :tag "Column"))
(cons :tag "End of name field"
:value (name-end . 24)
(const :tag "The column where the name should end in one-line layout"
name-end)
(number :tag "Column"))
(cons :tag "Toggle"
(const :tag "The layout is included when toggling layout" toggle)
boolean)
(cons :tag "Primary Mail Only"
(const :tag "Only the primary mail address is included" primary)
boolean)
(cons :tag "Display-p"
(const :tag "Show only records passing this test" display-p)
(choice (const :tag "No test" nil)
(function :tag "Predicate")))))))
(defcustom bbdb-layout 'multi-line
"Default display layout."
:group 'bbdb-record-display
:type '(choice (const one-line)
(const multi-line)
(const full-multi-line)
(symbol)))
(defcustom bbdb-pop-up-layout 'pop-up-multi-line
"Default layout for pop-up BBDB buffers (mail, news, etc.)."
:group 'bbdb-record-display
:type '(choice (const one-line)
(const multi-line)
(const full-multi-line)
(symbol)))
(defcustom bbdb-wrap-column nil
"Wrap column for multi-line display. If nil do not wrap lines."
:group 'bbdb-record-display
:type '(choice (const :tag "No line wrapping" nil)
(number :tag "Wrap column")))
(defcustom bbdb-case-fold-search (default-value 'case-fold-search)
"Value of `case-fold-search' used by BBDB and friends.
This variable lets the case-sensitivity of the BBDB commands
be different from standard commands like command `isearch-forward'."
:group 'bbdb-record-display
:type 'boolean)
(defcustom bbdb-name-format 'first-last
"Format for displaying names.
If first-last names are displayed as \"Firstname Lastname\".
If last-first names are displayed as \"Lastname, Firstname\".
This can be overriden per record via the xfield name-format,
which should take the same values.
See also `bbdb-read-name-format'."
:group 'bbdb-record-display
:type '(choice (const :tag "Firstname Lastname" first-last)
(const :tag "Lastname, Firstname" last-first)))
;; See http://en.wikipedia.org/wiki/Postal_address
;; http://www.upu.int/en/activities/addressing/postal-addressing-systems-in-member-countries.html
(defcustom bbdb-address-format-list
'((("Argentina") "spcSC" "@%s\n@%p, @%c@, %S@\n%C@" "@%c@")
(("Australia") "scSpC" "@%s\n@%c@ %S@ %p@\n%C@" "@%c@")
(("Austria" "Germany" "Spain" "Switzerland")
"spcSC" "@%s\n@%p @%c@ (%S)@\n%C@" "@%c@")
(("Canada") "scSCp" "@%s\n@%c@, %S@\n%C@ %p@" "@%c@")
(("China") "scpSC" "@%s\n@%c@\n%p@ %S@\n%C@" "@%c@") ; English format
; (("China") "CpScs" "@%C @%p\n@%S @%c@ %s@" "@%c@") ; Chinese format
(("India") "scpSC" "@%s\n@%c@ %p@ (%S)@\n%C@" "@%c@")
(("USA") "scSpC" "@%s\n@%c@, %S@ %p@\n%C@" "@%c@")
(t bbdb-edit-address-default bbdb-format-address-default "@%c@"))
"List of address editing and formatting rules for BBDB.
Each rule is a list (IDENTIFIER EDIT FORMAT FORMAT).
The first rule for which IDENTIFIER matches an address is used for editing
and formatting the address.
IDENTIFIER may be a list of countries.
IDENTIFIER may also be a function that is called with one arg, the address
to be used. The rule applies if the function returns non-nil.
See `bbdb-address-continental-p' for an example.
If IDENTIFIER is t, this rule always applies. Usually, this should be
the last rule that becomes a fall-back (default).
EDIT may be a function that is called with one argument, the address.
See `bbdb-edit-address-default' for an example.
EDIT may also be an editting format string. It is a string containing
the five letters s, c, p, S, and C that specify the order for editing
the five elements of an address:
s streets
c city
p postcode
S state
C country
The first FORMAT of each rule is used for multi-line layout, the second FORMAT
is used for one-line layout.
FORMAT may be a function that is called with one argument, the address.
See `bbdb-format-address-default' for an example.
FORMAT may also be a format string. It consists of formatting elements
separated by a delimiter defined via the first (and last) character of FORMAT.
Each formatting element may contain one of the following format specifiers:
%s streets (used repeatedly for each street part)
%c city
%p postcode
%S state
%C country
A formatting element will be applied only if the corresponding part
of the address is a non-empty string.
See also `bbdb-print-address-format-list'."
:group 'bbdb-record-display
:type '(repeat (list (choice (const :tag "Default" t)
(function :tag "Function")
(repeat (string)))
(choice (string)
(function :tag "Function"))
(choice (string)
(function :tag "Function"))
(choice (string)
(function :tag "Function")))))
(defcustom bbdb-continental-postcode-regexp
"^\\s *[A-Z][A-Z]?\\s *-\\s *[0-9][0-9][0-9]"
"Regexp matching continental postcodes.
Used by address format identifier `bbdb-address-continental-p'.
The regexp should match postcodes of the form CH-8052, NL-2300RA,
and SE-132 54."
:group 'bbdb-record-display
:type 'regexp)
(defcustom bbdb-default-separator '("[,;]" ", ")
"The default field separator. It is a list (SPLIT-RE JOIN).
This is used for fields which do not have an entry in `bbdb-separator-alist'."
:group 'bbdb-record-display
:type '(list regexp string))
(defcustom bbdb-separator-alist
'((record "\n\n" "\n\n") ; used by `bbdb-copy-fields-as-kill'
(name-first-last "[ ,;]" " ") (name-last-first "[ ,;]" ", ")
(name-field ":\n" ":\n") ; used by `bbdb-copy-fields-as-kill'
(phone "[,;]" ", ") (address ";\n" ";\n") ; ditto
(organization "[,;]" ", ") (affix "[,;]" ", ") (aka "[,;]" ", ")
(mail "[,;]" ", ") (mail-alias "[,;]" ", ") (vm-folder "[,;]" ", ")
(birthday "\n" "\n") (wedding "\n" "\n") (anniversary "\n" "\n")
(notes "\n" "\n"))
"Alist of field separators.
Each element is of the form (FIELD SPLIT-RE JOIN).
For fields lacking an entry here `bbdb-default-separator' is used instead."
:group 'bbdb-record-display
:type '(repeat (list symbol regexp string)))
(defcustom bbdb-user-menu-commands nil
"User defined menu entries which should be appended to the BBDB menu.
This should be a list of menu entries.
When set to a function, it is called with two arguments RECORD and FIELD
and it should either return nil or a list of menu entries.
Used by `bbdb-mouse-menu'."
:group 'bbdb-record-display
:type 'sexp)
(defcustom bbdb-display-hook nil
"Hook run after the *BBDB* is filled in."
:group 'bbdb-record-display
:type 'hook)
(defcustom bbdb-multiple-buffers nil
"When non-nil we create a new buffer of every buffer causing pop-ups.
You can also set this to a function returning a buffer name.
Here a value may be the predefined function `bbdb-multiple-buffers-default'."
:group 'bbdb-record-display
:type '(choice (const :tag "Disabled" nil)
(function :tag "Enabled" bbdb-multiple-buffers-default)
(function :tag "User defined function")))
(defcustom bbdb-image nil
"If non-nil display records with an image.
If a symbol this should be an xfield holding the name of the image file
associated with the record. If it is `name' or `fl-name', the first and last
name of the record are used as file name. If it is `lf-name', the last and
first name of the record are used as file name.
If a function it is called with one arg, the record, and it should return
the name of the image file.
The file is searched in the directories in `bbdb-image-path'.
File name suffixes are appended according to `bbdb-image-suffixes'.
See `locate-file'."
:group 'bbdb-record-display
:type '(choice (const :tag "Disabled" nil)
(function :tag "User defined function")
(symbol :tag "Record field")))
(defcustom bbdb-image-path nil
"List of directories to search for `bbdb-image'."
:group 'bbdb-record-display
:type '(repeat (directory)))
(defcustom bbdb-image-suffixes '(".png" ".jpg" ".gif" ".xpm")
"List of file name suffixes searched for `bbdb-image'."
:group 'bbdb-record-display
:type '(repeat (string :tag "File suffix")))
(defcustom bbdb-read-name-format 'fullname
"Default format for reading names via `bbdb-read-name'.
If it is 'first-last read first and last name separately.
If it is 'last-first read last and first name separately.
With any other value read full name at once.
See also `bbdb-name-format'."
:group 'bbdb-record-display
:type '(choice (const :tag "Firstname Lastname" first-last)
(const :tag "Lastname, Firstname" last-first)
(const :tag "Full name" fullname)))
;;; Record editing
(defcustom bbdb-lastname-prefixes
'("von" "de" "di")
"List of lastname prefixes recognized in name fields.
Used to enhance dividing name strings into firstname and lastname parts.
Case is ignored."
:group 'bbdb-record-edit
:type '(repeat string))
(defcustom bbdb-lastname-re
(concat "[- \t]*\\(\\(?:\\<"
(regexp-opt bbdb-lastname-prefixes)
;; multiple last names concatenated by `-'
"\\>[- \t]+\\)?\\(?:\\w+[ \t]*-[ \t]*\\)*\\w+\\)\\'")
"Regexp matching the last name of a full name.
Its first parenthetical subexpression becomes the last name."
:group 'bbdb-record-edit
:type 'regexp)
(defcustom bbdb-lastname-suffixes
'("Jr" "Sr" "II" "III")
"List of lastname suffixes recognized in name fields.
Used to dividing name strings into firstname and lastname parts.
All suffixes are complemented by optional `.'. Case is ignored."
:group 'bbdb-record-edit
:type '(repeat string))
(defcustom bbdb-lastname-suffix-re
(concat "[-,. \t/\\]+\\("
(regexp-opt bbdb-lastname-suffixes)
;; suffices are complemented by optional `.'.
"\\.?\\)\\W*\\'")
"Regexp matching the suffix of a last name.
Its first parenthetical subexpression becomes the suffix."
:group 'bbdb-record-edit
:type 'regexp)
(defcustom bbdb-default-domain nil
"Default domain to append when reading a new mail address.
If a mail address does not contain `[@%!]', append @`bbdb-default-domain' to it.
The address is not altered if `bbdb-default-domain' is nil
or if a prefix argument is given to the command `bbdb-insert-field'."
:group 'bbdb-record-edit
:type '(choice (const :tag "none" nil)
(string :tag "Default Domain" :value nil)))
(defcustom bbdb-phone-style 'nanp
"Phone numbering plan assumed by BBDB.
The value 'nanp refers to the North American Numbering Plan.
The value nil refers to a free-style numbering plan.
You can have both styles of phone number in your database by providing a
prefix argument to the command `bbdb-insert-field'."
:group 'bbdb-record-edit
:type '(choice (const :tag "NANP" nanp)
(const :tag "none" nil)))
(defcustom bbdb-default-area-code nil
"Default area code to use when reading a new phone number.
This variable also affects dialing."
:group 'bbdb-record-edit
:type '(choice (const :tag "none" nil)
(integer :tag "Default Area Code"))
:set (lambda( symb val )
(if (or (and (stringp val)
(string-match "^[0-9]+$" val))
(integerp val)
(null val))
(set symb val)
(error "%s must contain digits only." symb))))
(defcustom bbdb-allow-duplicates nil
"When non-nil BBDB allows records with duplicate names and email addresses.
In rare cases, this may lead to confusion with BBDB's MUA interface."
:group 'bbdb-record-edit
:type 'boolean)
(defcustom bbdb-default-label-list '("home" "work" "other")
"Default list of labels for Address and Phone fields."
:group 'bbdb-record-edit
:type '(repeat string))
(defcustom bbdb-address-label-list bbdb-default-label-list
"List of labels for Address field."
:group 'bbdb-record-edit
:type '(repeat string))
(defcustom bbdb-phone-label-list '("home" "work" "cell" "other")
"List of labels for Phone field."
:group 'bbdb-record-edit
:type '(repeat string))
(defcustom bbdb-default-country "Emacs";; what do you mean, it's not a country?
"Default country to use if none is specified."
:group 'bbdb-record-edit
:type '(choice (const :tag "None" nil)
(string :tag "Default Country")))
(defcustom bbdb-check-postcode t
"If non-nil, require legal postcodes when entering an address.
The format of legal postcodes is determined by the variable
`bbdb-legal-postcodes'."
:group 'bbdb-record-edit
:type 'boolean)
(defcustom bbdb-legal-postcodes
'(;; empty string
"^$"
;; Matches 1 to 6 digits.
"^[ \t\n]*[0-9][0-9]?[0-9]?[0-9]?[0-9]?[0-9]?[ \t\n]*$"
;; Matches 5 digits and 3 or 4 digits.
"^[ \t\n]*\\([0-9][0-9][0-9][0-9][0-9]\\)[ \t\n]*-?[ \t\n]*\\([0-9][0-9][0-9][0-9]?\\)[ \t\n]*$"
;; Match postcodes for Canada, UK, etc. (result is ("LL47" "U4B")).
"^[ \t\n]*\\([A-Za-z0-9]+\\)[ \t\n]+\\([A-Za-z0-9]+\\)[ \t\n]*$"
;; Match postcodes for continental Europe. Examples "CH-8057"
;; or "F - 83320" (result is ("CH" "8057") or ("F" "83320")).
;; Support for "NL-2300RA" added at request from Carsten Dominik
;; <dominik@astro.uva.nl>
"^[ \t\n]*\\([A-Z]+\\)[ \t\n]*-?[ \t\n]*\\([0-9]+ ?[A-Z]*\\)[ \t\n]*$"
;; Match postcodes from Sweden where the five digits are grouped 3+2
;; at the request from Mats Lofdahl <MLofdahl@solar.stanford.edu>.
;; (result is ("SE" (133 36)))
"^[ \t\n]*\\([A-Z]+\\)[ \t\n]*-?[ \t\n]*\\([0-9]+\\)[ \t\n]+\\([0-9]+\\)[ \t\n]*$")
"List of regexps that match legal postcodes.
Whether this is used at all depends on the variable `bbdb-check-postcode'."
:group 'bbdb-record-edit
:type '(repeat regexp))
(defcustom bbdb-default-xfield 'notes
"Default xfield when editing BBDB records."
:group 'bbdb-record-edit
:type '(symbol :tag "Xfield"))
(defcustom bbdb-edit-foo (cons bbdb-default-xfield 'current-fields)
"Fields to edit with command `bbdb-edit-foo'.
This is a cons pair (WITHOUT-PREFIX . WITH-PREFIX).
The car is used if the command is called without a prefix.
The cdr is used if the command is called with a prefix.
WITHOUT-PREFIX and WITH-PREFIX may take the values:
name The full name
affix The list of affixes
organization The list of organizations
aka the list of AKAs
mail the list of email addresses
phone the list of phone numbers
address the list of addresses
current-fields Read the field to edit using a completion table
that includes all fields of the current record.
all-fields Read the field to edit using a completion table
that includes all fields currently known to BBDB.
Any other symbol is interpreted as the label of an xfield."
:group 'bbdb-record-edit
:type '(cons (symbol :tag "Field without prefix")
(symbol :tag "Field with prefix")))
;;; MUA interface
(defcustom bbdb-annotate-field bbdb-default-xfield
"Field to annotate via `bbdb-annotate-record' and friends.
This may take the values:
affix The list of affixes
organization The list of organizations
aka the list of AKAs
mail the list of email addresses
all-fields Read the field to edit using a completion table
that includes all fields currently known to BBDB.
Any other symbol is interpreted as the label of an xfield."
:group 'bbdb-mua
:type '(symbol :tag "Field to annotate"))
(defcustom bbdb-mua-edit-field bbdb-default-xfield
"Field to edit with command `bbdb-mua-edit-field' and friends.
This may take the values:
name The full name
affix The list of affixes
organization The list of organizations
aka the list of AKAs
mail the list of email addresses
all-fields Read the field to edit using a completion table
that includes all fields currently known to BBDB.
Any other symbol is interpreted as the label of an xfield."
:group 'bbdb-mua
:type '(symbol :tag "Field to edit"))
(defcustom bbdb-mua-update-interactive-p '(search . query)
"How BBDB's interactive MUA commands update BBDB records.
This is a cons pair (WITHOUT-PREFIX . WITH-PREFIX).
The car is used if the command is called without a prefix.
The cdr is used if the command is called with a prefix (and if the prefix
is not used for another purpose).
WITHOUT-PREFIX and WITH-PREFIX may take the values
\(here ADDRESS is an email address found in a message):
nil Do nothing.
search Search for existing records matching ADDRESS.
update Search for existing records matching ADDRESS;
update name and mail field if necessary.
query Search for existing records matching ADDRESS;
query for creation of a new record if the record does not exist.
create or t Search for existing records matching ADDRESS;
create a new record if it does not yet exist.
a function This functions will be called with no arguments.
It should return one of the above values.
read Read the value interactively."
:group 'bbdb-mua
:type '(cons (choice (const :tag "do nothing" nil)
(const :tag "search for existing records" search)
(const :tag "update existing records" update)
(const :tag "query annotation of all messages" query)
(const :tag "annotate all messages" create)
(function :tag "User-defined function")
(const :tag "read arg interactively" read))
(choice (const :tag "do nothing" nil)
(const :tag "search for existing records" search)
(const :tag "update existing records" update)
(const :tag "query annotation of all messages" query)
(const :tag "annotate all messages" create)
(function :tag "User-defined function")
(const :tag "read arg interactively" read))))
(defcustom bbdb-mua-auto-update-p 'bbdb-select-message
"How `bbdb-mua-auto-update' updates BBDB records automatically.
Allowed values are (here ADDRESS is an email address found in a message):
nil Do nothing.
search Search for existing records matching ADDRESS.
update Search for existing records matching ADDRESS;
update name and mail field if necessary.
query Search for existing records matching ADDRESS;
query for creation of a new record if the record does not exist.
create or t Search for existing records matching ADDRESS;
create a new record if it does not yet exist.
a function This functions will be called with no arguments.
It should return one of the above values.
For an example, see `bbdb-select-message' with
`bbdb-mua-update-records-p', `bbdb-accept-message-alist'
and `bbdb-ignore-message-alist'.
To initiate auto-updating of BBDB records, call `bbdb-mua-auto-update-init'
for the respective MUAs in your init file."
:group 'bbdb-mua
:type '(choice (const :tag "do nothing" nil)
(const :tag "search for existing records" search)
(const :tag "update existing records" update)
(const :tag "query annotation of all messages" query)
(const :tag "annotate all messages" create)
(function :tag "User-defined function")))
(defcustom bbdb-update-records-p 'search
"Return value for `bbdb-select-message' and friends.
These functions can select messages for further processing by BBDB,
The amount of subsequent processing is determined by `bbdb-update-records-p'.
Allowed values are (here ADDRESS is an email address selected
by `bbdb-select-message'):
nil Do nothing.
search Search for existing records matching ADDRESS.
update Search for existing records matching ADDRESS;
update name and mail field if necessary.
query Search for existing records matching ADDRESS;
query for creation of a new record if the record does not exist.
create or t Search for existing records matching ADDRESS;
create a new record if it does not yet exist.
a function This functions will be called with no arguments.
It should return one of the above values."
;; Also: Used for communication between `bbdb-update-records'
;; and `bbdb-query-create'.
:group 'bbdb-mua
:type '(choice (const :tag "do nothing" nil)
(const :tag "search for existing records" search)
(const :tag "update existing records" update)
(const :tag "query annotation of all messages" query)
(const :tag "annotate all messages" create)
(function :tag "User-defined function")))
(defcustom bbdb-message-headers
'((sender "From" "Resent-From" "Reply-To" "Sender")
(recipients "Resent-To" "Resent-CC" "To" "CC" "BCC"))
"Alist of headers to search for sender and recipients mail addresses.
Each element is of the form
(CLASS HEADER ...)
The symbol CLASS defines a class of headers.
The strings HEADER belong to CLASS."
:group 'bbdb-mua
:type 'list)
(defcustom bbdb-message-all-addresses nil
"If t `bbdb-update-records' returns all mail addresses of a message.
Otherwise this function returns only the first mail address of each message."
:group 'bbdb-mua
:type 'boolean)
(defcustom bbdb-message-try-all-headers nil
"If t try all message headers to extract an email address from a message.
Several BBDB commands extract either the sender or the recipients' email
addresses from a message according to `bbdb-message-headers'. If BBDB does not
find any email address in this subset of message headers (for example, because
an email address is excluded because of `bbdb-user-mail-address-re')
but `bbdb-message-try-all-headers' is t, then these commands will also consider
the email addresses in the remaining headers."
:group 'bbdb-mua
:type 'boolean)
(defcustom bbdb-accept-message-alist t
"Alist describing which messages to automatically create BBDB records for.
The format of this alist is
((HEADER-NAME . REGEXP) ...)
For example, if
((\"From\" . \"@.*\\.maximegalon\\.edu\")
(\"Subject\" . \"time travel\"))
BBDB records are only created for messages sent by people at Maximegalon U.,
or people posting about time travel.
If t accept all messages. If nil do not accept any messages.
See also `bbdb-ignore-message-alist', which has the opposite effect."
:group 'bbdb-mua
:type '(repeat (cons
(string :tag "Header name")
(regexp :tag "Regexp to match on header value"))))
(defcustom bbdb-ignore-message-alist nil
"Alist describing which messages not to automatically create BBDB records for.
The format of this alist is
((HEADER-NAME . REGEXP) ... )
For example, if
((\"From\" . \"mailer-daemon\")
((\"To\" \"CC\") . \"mailing-list-1\\\\|mailing-list-2\"))
no BBDB records are created for messages from any mailer daemon,
or messages sent to or CCed to either of two mailing lists.
If t ignore all messages. If nil do not ignore any messages.
See also `bbdb-accept-message-alist', which has the opposite effect."
:group 'bbdb-mua
:type '(repeat (cons
(string :tag "Header name")
(regexp :tag "Regexp to match on header value"))))
(defcustom bbdb-user-mail-address-re
(and (stringp user-mail-address)
(string-match "\\`\\([^@]*\\)\\(@\\|\\'\\)" user-mail-address)
(concat "\\<" (regexp-quote (match-string 1 user-mail-address)) "\\>"))
"A regular expression matching your mail addresses.
Several BBDB commands extract either the sender or the recipients' email
addresses from a message according to `bbdb-message-headers'. Yet an email
address will be ignored if it matches `bbdb-user-mail-address-re'. This way
the commands will not operate on your own record.
See also `bbdb-message-try-all-headers'."
:group 'bbdb-mua
:type '(regexp :tag "Regexp matching your mail addresses"))
(defcustom bbdb-add-name 'query
"How to handle new names for existing BBDB records.
This handles messages where the real name differs from the name
in a BBDB record with the same mail address, as in \"John Smith <jqs@frob.com>\"
versus \"John Q. Smith <jqs@frob.com>\".
Allowed values are:
t Automatically change the name to the new value.
query Query whether to use the new name.
nil Ignore the new name.
a number Number of seconds BBDB displays the name mismatch.
(without further action).
a function This is called with two args, the record and the new name.
It should return one of the above values.
a regexp If the new name matches this regexp ignore it.
Otherwise query to add it.
See also `bbdb-add-aka'."
:group 'bbdb-mua
:type '(choice (const :tag "Automatically use the new name" t)
(const :tag "Query for name changes" query)
(const :tag "Ignore the new name" nil)
(integer :tag "Number of seconds to display name mismatch")
(function :tag "Function for analyzing name handling")
(regexp :tag "If the new name matches this regexp ignore it.")))
(defcustom bbdb-add-aka 'query
"How to handle alternate names for existing BBDB records.
Allowed values are:
t Automatically store alternate names as AKA.
query Query whether to store alternate names as an AKA.
nil Ignore alternate names.
a function This is called with two args, the record and the new name.
It should return one of the above values.
a regexp If the alternate name matches this regexp ignore it.
Otherwise query to add it.
See also `bbdb-add-name'."
:group 'bbdb-mua
:type '(choice (const :tag "Automatically store alternate names as AKA" t)
(const :tag "Query for alternate names" query)
(const :tag "Ignore alternate names" nil)
(function :tag "Function for alternate name handling")
(regexp :tag "If the alternate name matches this regexp ignore it.")))
(defcustom bbdb-add-mails 'query
"How to handle new mail addresses for existing BBDB records.
This handles messages where the mail address differs from the mail addresses
in a BBDB record with the same name as in \"John Q. Smith <jqs@foo.com>\"
versus \"John Q. Smith <jqs@bar.com>\".
Allowed values are:
t Automatically add new mail addresses to the list of mail addresses.
query Query whether to add it.
nil Ignore new mail addresses.
a number Number of seconds BBDB displays the new address
(without further action).
a function This is called with two args, the record and the new mail address.
It should return one of the above values.
a regexp If the new mail address matches this regexp ignore the new address.
Otherwise query to add it.
See also `bbdb-new-mails-primary' and `bbdb-ignore-redundant-mails'."
:group 'bbdb-mua
:type '(choice (const :tag "Automatically add new mail addresses" t)
(const :tag "Query before adding new mail addresses" query)
(const :tag "Never add new mail addresses" nil)
(number :tag "Number of seconds to display new addresses")
(function :tag "Function for analyzing name handling")
(regexp :tag "If the new address matches this regexp ignore it.")))
(defcustom bbdb-new-mails-primary 'query
"Where to put new mail addresses for existing BBDB records.
A new mail address may either become the new primary mail address,
when it is put at the beginning of the list of mail addresses.
Or the new mail address is added at the end of the list of mail addresses.
Allowed values are:
t Make a new address automatically the primary address.
query Query whether to make it the primary address.
nil Add the new address to the end of the list.
a function This is called with two args, the record and the new mail address.
It should return one of the above values.
a regexp If the new mail address matches this regexp put it at the end.
Otherwise query to make it the primary address.
See also `bbdb-add-mails'."
:group 'bbdb-mua
:type '(choice (const :tag "New address automatically made primary" t)
(const :tag "Query before making a new address primary" query)
(const :tag "Do not make new address primary" nil)
(function :tag "Function for analyzing primary handling")
(regexp :tag "If the new mail address matches this regexp put it at the end.")))
(defcustom bbdb-canonicalize-mail-function nil
"If non-nil, it should be a function of one arg: a mail address string.
When BBDB \"notices\" a message, the corresponding mail addresses are passed
to this function first. It acts as a kind of \"filter\" to transform
the mail addresses before they are compared against or added to the database.
See `bbdb-canonicalize-mail-1' for a more complete example.
If this function returns nil, BBDB assumes that there is no mail address.
See also `bbdb-ignore-redundant-mails'."
:group 'bbdb-mua
:type 'function)
(defcustom bbdb-ignore-redundant-mails 'query
"How to handle redundant mail addresses for existing BBDB records.
For example, \"foo@bar.baz.com\" is redundant w.r.t. \"foo@baz.com\".
This affects two things, whether a new redundant mail address is added
to BBDB and whether an old mail address, which has become redundant
because of a newly added mail address, is removed from BBDB.
Allowed values are:
t Automatically ignore redundant mail addresses.
query Query whether to ignore them.
nil Do not ignore redundant mail addresses.
a number Number of seconds BBDB displays redundant mail addresses
(without further action).
a function This is called with two args, the record and the new mail address.
It should return one of the above values.
a regexp If the new mail address matches this regexp never ignore
this mail address. Otherwise query to ignore it.
See also `bbdb-add-mails' and `bbdb-canonicalize-mail-function'."
:group 'bbdb-mua
:type '(choice (const :tag "Automatically ignore redundant mail addresses" t)
(const :tag "Query whether to ignore them" query)
(const :tag "Do not ignore redundant mail addresses" nil)
(number :tag "Number of seconds to display redundant addresses")
(function :tag "Function for handling redundant mail addresses")
(regexp :tag "If the new address matches this regexp never ignore it.")))
(define-obsolete-variable-alias 'bbdb-canonicalize-redundant-mails
'bbdb-ignore-redundant-mails)
(defcustom bbdb-message-clean-name-function 'bbdb-message-clean-name-default
"Function to clean up the name in the header of a message.
It takes one argument, the name as extracted by
`mail-extract-address-components'."
:group 'bbdb-mua
:type 'function)
(defcustom bbdb-message-mail-as-name t
"If non-nil use mail address of message as fallback for name of new records."
:group 'bbdb-mua
:type 'boolean)
(defcustom bbdb-notice-mail-hook nil
"Hook run each time a mail address of a record is \"noticed\" in a message.
This means that the mail address in a message belongs to an existing BBDB record
or to a record BBDB has created for the mail address.
Run with one argument, the record. It is up to the hook function
to determine which MUA is used and to act appropriately.
Hook functions can use the variable `bbdb-update-records-address'
to determine the header and class of the mail address according
to `bbdb-message-headers'. See `bbdb-auto-notes' for how to annotate records
using `bbdb-update-records-address' and the headers of a mail message.
If a message contains multiple mail addresses belonging to one BBDB record,
this hook is run for each mail address. Use `bbdb-notice-record-hook'
if you want to notice each record only once per message."
:group 'bbdb-mua
:type 'hook)
(defcustom bbdb-notice-record-hook nil
"Hook run each time a BBDB record is \"noticed\" in a message.
This means that one of the mail addresses in a message belongs to an existing
record or it is a record BBDB has created for the mail address. If a message
contains multiple mail addresses belonging to one BBDB record, this hook
is nonetheless run only once. Use `bbdb-notice-mail-hook' if you want to run
a hook function for each mail address in a message.
Hook is run with one argument, the record."
:group 'bbdb-mua
:type 'hook)
(define-widget 'bbdb-alist-with-header 'group
"My group"
:match 'bbdb-alist-with-header-match
:value-to-internal (lambda (widget value)
(if value (list (car value) (cdr value))))
:value-to-external (lambda (widget value)
(if value (append (list (car value)) (cadr value)))))
(defun bbdb-alist-with-header-match (widget value)
(widget-group-match widget
(widget-apply widget :value-to-internal value)))
(defvar bbdb-auto-notes-rules-expanded nil
"Expanded `bbdb-auto-notes-rules'.") ; Internal variable
(defcustom bbdb-auto-notes-rules nil
"List of rules for adding notes to records of mail addresses of messages.
This automatically annotates the BBDB record of the sender or recipient
of a message based on the value of a header such as the Subject header.
This requires that `bbdb-notice-mail-hook' contains `bbdb-auto-notes'
and that the record already exists or `bbdb-update-records-p' returns such that
the record will be created. Messages matching `bbdb-auto-notes-ignore-messages'
are ignored.
The elements of this list are
(MUA FROM-TO HEADER ANNOTATE ...)
(FROM-TO HEADER ANNOTATE ...)
(HEADER ANNOTATE ...)
MUA is the active MUA or a list of MUAs (see `bbdb-mua').
If MUA is missing or t, use this rule for all MUAs.
FROM-TO is a list of headers and/or header classes as in `bbdb-message-headers'.
The record corresponding to a mail address of a message is considered for
annotation if this mail address was found in a header matching FROM-TO.
If FROM-TO is missing or t, records for each mail address are considered
irrespective of where the mail address was found in a message.
HEADER is a message header that is considered for generating the annotation.
ANNOTATE may take the following values:
(REGEXP . STRING) [this is equivalent to (REGEXP notes STRING)]
(REGEXP FIELD STRING)
(REGEXP FIELD STRING REPLACE)
REGEXP must match the value of HEADER for generating an annotation.
However, if the value of HEADER also matches an element of
`bbdb-auto-notes-ignore-headers' no annotation is generated.
The annotation will be added to FIELD of the respective record.
FIELD defaults to `bbdb-default-xfield'.
STRING defines a replacement for the match of REGEXP in the value of HEADER.
It may contain \\& or \\N specials used by `replace-match'.
The resulting string becomes the annotation.
If STRING is an integer N, the Nth matching subexpression is used.
If STRING is a function, it will be called with one arg, the value of HEADER.
The return value (which must be a string) is then used.
If REPLACE is t, the resulting string replaces the old contents of FIELD.
If it is nil, the string is appended to the contents of FIELD (unless the
annotation is already part of the content of field).
For example,
((\"To\" (\"-vm@\" . \"VM mailing list\"))
(\"Subject\" (\"sprocket\" . \"mail about sprockets\")
(\"you bonehead\" . \"called me a bonehead\")))
will cause the text \"VM mailing list\" to be added to the notes field
of the records corresponding to anyone you get mail from via one of the VM
mailing lists.
If multiple clauses match the message, all of the corresponding strings
will be added.
See also variables `bbdb-auto-notes-ignore-messages' and
`bbdb-auto-notes-ignore-headers'.
For speed-up, the function `bbdb-auto-notes' actually use expanded rules
stored in the internal variable `bbdb-auto-notes-rules-expanded'.
If you change the value of `bbdb-auto-notes-rules' outside of customize,
set `bbdb-auto-notes-rules-expanded' to nil, so that the expanded rules
will be re-evaluated."
:group 'bbdb-mua
:set (lambda (symbol value)
(set-default symbol value)
(setq bbdb-auto-notes-rules-expanded nil))
:type '(repeat
(bbdb-alist-with-header
(repeat (choice
(const sender)
(const recipients)))
(string :tag "Header name")
(repeat (choice
(cons :tag "Value Pair"
(regexp :tag "Regexp to match on header value")
(string :tag "String for notes if regexp matches"))
(list :tag "Replacement list"
(regexp :tag "Regexp to match on header value")
(choice :tag "Record field"
(const notes :tag "xfields")
(const organization :tag "Organization")
(symbol :tag "Other"))
(choice :tag "Regexp match"
(string :tag "Replacement string")
(integer :tag "Subexpression match")
(function :tag "Callback Function"))
(choice :tag "Replace previous contents"
(const :tag "No" nil)
(const :tag "Yes" t))))))))
(defcustom bbdb-auto-notes-ignore-messages nil
"List of rules for ignoring entire messages in `bbdb-auto-notes'.
The elements may have the following values:
a function This function is called with one arg, the record
that would be annotated.
Ignore this message if the function returns non-nil.
This function may use `bbdb-update-records-address'.
MUA Ignore messages from MUA (see `bbdb-mua').
(HEADER . REGEXP) Ignore messages where HEADER matches REGEXP.
For example, (\"From\" . bbdb-user-mail-address-re)
disables any recording of notes for mail addresses
found in messages coming from yourself, see
`bbdb-user-mail-address-re'.
(MUA HEADER REGEXP) Ignore messages from MUA where HEADER
matches REGEXP.
See also `bbdb-auto-notes-ignore-headers'."
:group 'bbdb-mua
:type '(repeat (cons
(string :tag "Header name")
(regexp :tag "Regexp to match on header value"))))
(defcustom bbdb-auto-notes-ignore-headers nil
"Alist of headers and regexps to ignore in `bbdb-auto-notes'.
Each element is of the form
(HEADER . REGEXP)
For example,
(\"Organization\" . \"^Gatewayed from\\\\\|^Source only\")
will exclude the phony `Organization:' headers in GNU mailing-lists
gatewayed to gnu.* newsgroups.
See also `bbdb-auto-notes-ignore-messages'."
:group 'bbdb-mua
:type '(repeat (cons
(string :tag "Header name")
(regexp :tag "Regexp to match on header value"))))
(defcustom bbdb-mua-pop-up t
"If non-nil, display an auto-updated BBDB window while using a MUA.
If 'horiz, stack the window horizontally if there is room.
If this is nil, BBDB is updated silently.
See also `bbdb-mua-pop-up-window-size' and `bbdb-horiz-pop-up-window-size'."
:group 'bbdb-mua
:type '(choice (const :tag "MUA BBDB window stacked vertically" t)
(const :tag "MUA BBDB window stacked horizontally" 'horiz)
(const :tag "No MUA BBDB window" nil)))
(define-obsolete-variable-alias 'bbdb-message-pop-up 'bbdb-mua-pop-up)
(defcustom bbdb-mua-pop-up-window-size bbdb-pop-up-window-size
"Vertical size of MUA pop-up BBDB window (vertical split).
If it is an integer number, it is the number of lines used by BBDB.
If it is a fraction between 0.0 and 1.0 (inclusive), it is the fraction
of the tallest existing window that BBDB will take over.
If it is t use `pop-to-buffer' to create the BBDB window.
See also `bbdb-pop-up-window-size'."
:group 'bbdb-mua
:type '(choice (number :tag "BBDB window size")
(const :tag "Use `pop-to-buffer'" t)))
(defcustom bbdb-horiz-pop-up-window-size '(112 . 0.3)
"Horizontal size of a MUA pop-up BBDB window (horizontal split).
It is a cons pair (TOTAL . BBDB-SIZE).
The window that will be considered for horizontal splitting must have
at least TOTAL columns. BBDB-SIZE is the horizontal size of the BBDB window.
If it is an integer number, it is the number of columns used by BBDB.
If it is a fraction between 0 and 1, it is the fraction of the
window width that BBDB will take over."
:group 'bbdb-mua
:type '(cons (number) (number)))
;;; xfields processing
(defcustom bbdb-xfields-sort-order
'((notes . 0) (url . 1) (ftp . 2) (gopher . 3) (telnet . 4) (mail-alias . 5)
(mail-folder . 6) (lpr . 7) (creation-date . 1000) (timestamp . 1001))
"The order for sorting the xfields.
If an xfield is not in the alist, it is assigned weight 100, so all xfields
with weights less then 100 will be in the beginning, and all xfields with
weights more than 100 will be in the end."
:group 'bbdb-mua
:type 'list)
(define-obsolete-variable-alias 'bbdb-notes-sort-order 'bbdb-xfields-sort-order)
(defcustom bbdb-merge-xfield-function-alist
'((creation-date . bbdb-merge-string-least)
(timestamp . bbdb-merge-string-most))
"An alist defining specific merging function for xfields.
Each element is of the form (LABEL . MERGE-FUN).
For merging xfield LABEL, this will use MERGE-FUN."
:group 'bbdb-mua
:type '(repeat (cons
(symbol :tag "xfield")
(function :tag "merge function"))))
(define-obsolete-variable-alias 'bbdb-merge-notes-function-alist
'bbdb-merge-xfield-function-alist)
(defcustom bbdb-mua-summary-unification-list
'(name mail message-name message-mail message-address)
"List of FIELDs considered by `bbdb-mua-summary-unify'.
For the RECORD matching the address of a message, `bbdb-mua-summary-unify'
returns the first non-empty field value matching an element FIELD from this list.
Each element FIELD may be a valid argument of `bbdb-record-field' for RECORD.
In addition, this list may also include the following elements:
message-name The name in the address of the message
message-mail The mail in the address of the message
message-address The complete address of the message
These provide a fallback if a message does not have a matching RECORD
or if some FIELD of RECORD is empty."
:group 'bbdb-mua
:type 'list)
(defcustom bbdb-mua-summary-mark-field 'mark-char
"BBDB xfield whose value is used to mark message addresses known to BBDB.
This may also be a function, called with one arg, the record, which should
return the mark. See `bbdb-mua-summary-mark' and `bbdb-mua-summary-unify'.
See also `bbdb-mua-summary-mark'."
:group 'bbdb-mua-gnus
:type 'symbol)
(defcustom bbdb-mua-summary-mark "+"
"Default mark for message addresses known to BBDB.
If nil do not mark message addresses known to BBDB.
See `bbdb-mua-summary-mark' and `bbdb-mua-summary-unify'.
See also `bbdb-mua-summary-mark-field'."
:group 'bbdb-mua
:type '(choice (string :tag "Mark used")
(const :tag "Do not mark known posters" nil)))
(defcustom bbdb-mua-summary-unify-format-letter "B"
"Letter required for `bbdb-mua-summary-unify' in the MUA Summary format string.
For Gnus, combine it with the %u specifier in `gnus-summary-line-format'
\(see there), for example use \"%U%R%z%I%(%[%4L: %-23,23uB%]%) %s\\n\".
For VM, combine it with the %U specifier in `vm-summary-format' (see there),
for example, use \"%n %*%a %-17.17UB %-3.3m %2d %4l/%-5c %I\\\"%s\\\"\\n\".
This customization of `gnus-summary-line-format' / `vm-summary-format'
is required to use `bbdb-mua-summary-unify'.
Currently no other MUAs support this BBDB feature."
:group 'bbdb-mua
:type 'string)
(defcustom bbdb-mua-summary-mark-format-letter "b"
"Letter required for `bbdb-mua-summary-mark' in the MUA Summary format string.
For Gnus, combine it with the %u specifier in `gnus-summary-line-format'
\(see there), for example, use \"%U%R%z%I%(%[%4L: %ub%-23,23f%]%) %s\\n\".
For VM, combine it with the %U specifier in `vm-summary-format' (see there),
for example, use \"%n %*%a %Ub%-17.17F %-3.3m %2d %4l/%-5c %I\\\"%s\\\"\\n\".
This customization of `gnus-summary-line-format' / `vm-summary-format'
is required to use `bbdb-mua-summary-mark'.
Currently no other MUAs support this BBDB feature."
:group 'bbdb-mua
:type 'string)
;;; Sending mail
(defcustom bbdb-mail-user-agent mail-user-agent
"Mail user agent used by BBDB.
Allowed values are those allowed for `mail-user-agent'."
:group 'bbdb-sendmail
:type '(radio (function-item :tag "Message package"
:format "%t\n"
message-user-agent)
(function-item :tag "Mail package"
:format "%t\n"
sendmail-user-agent)
(function-item :tag "Emacs interface to MH"
:format "%t\n"
mh-e-user-agent)
(function-item :tag "Message with full Gnus features"
:format "%t\n"
gnus-user-agent)
(function-item :tag "VM"
:format "%t\n"
vm-user-agent)
(function :tag "Other")
(const :tag "Default" nil)))
(defcustom bbdb-mail-name-format 'first-last
"Format for names when sending mail.
If first-last format names as \"Firstname Lastname\".
If last-first format names as \"Lastname, Firstname\".
If `bbdb-mail-name' returns the full name as a single string, this takes
precedence over `bbdb-mail-name-format'. Likewise, if the mail address itself
includes a name, this is not reformatted."
:group 'bbdb-sendmail
:type '(choice (const :tag "Firstname Lastname" first-last)
(const :tag "Lastname, Firstname" last-first)))
(defcustom bbdb-mail-name 'mail-name
"Xfield holding the full name for a record when sending mail.
This may also be a function taking one argument, a record.
If it returns the full mail name as a single string, this is used \"as is\".
If it returns a cons pair (FIRST . LAST) with the first and last name
for this record, these are formatted obeying `bbdb-mail-name-format'."
:group 'bbdb-sendmail
:type '(choice (symbol :tag "xfield")
(function :tag "mail name function")))
(defcustom bbdb-mail-alias-field 'mail-alias
"Xfield holding the mail alias for a record.
Used by `bbdb-mail-aliases'. See also `bbdb-mail-alias'."
:group 'bbdb-sendmail
:type 'symbol)
(defcustom bbdb-mail-alias 'first
"Defines which mail aliases are generated for a BBDB record.
first: Generate one alias \"<alias>\" that expands to the first mail address
of a record.
star: Generate a second alias \"<alias>*\" that expands to all mail addresses
of a record.
all: Generate the aliases \"<alias>\" and \"<alias>*\" (as for 'star)
and aliases \"<alias>n\" for each mail address, where n is the position
of the mail address of a record."
:group 'bbdb-sendmail
:type '(choice (symbol :tag "Only first" first)
(symbol :tag "<alias>* for all mails" star)
(symbol :tag "All aliases" all)))
(defcustom bbdb-mail-avoid-redundancy nil
"Mail address to use for BBDB records when sending mail.
If non-nil do not use full name in mail address when same as mail.
If value is mail-only never use full name."
:group 'bbdb-sendmail
:type '(choice (const :tag "Allow redundancy" nil)
(const :tag "Never use full name" 'mail-only)
(const :tag "Avoid redundancy" t)))
(defcustom bbdb-complete-mail t
"If t MUA insinuation provides key binding for command `bbdb-complete-mail'."
:group 'bbdb-sendmail
:type 'boolean)
(defcustom bbdb-completion-list t
"Controls the behaviour of `bbdb-complete-mail'.
If a list of symbols, it specifies which fields to complete. Symbols include
fl-name (= first and last name)
lf-name (= last and first name)
organization
aka
mail (= all email addresses of each record)
primary (= first email address of each record)
If t, completion is done for all of the above.
If nil, no completion is offered."
;; These symbols match the fields for which BBDB provides entries in
;; `bbdb-hash-table'.
:group 'bbdb-sendmail
:type '(choice (const :tag "No Completion" nil)
(const :tag "Complete across all fields" t)
(repeat :tag "Field"
(choice (const fl-name)
(const lf-name)
(const aka)
(const organization)
(const primary)
(const mail)))))
(defcustom bbdb-complete-mail-allow-cycling nil
"If non-nil cycle mail addresses when calling `bbdb-complete-mail'."
:group 'bbdb-sendmail
:type 'boolean)
(defcustom bbdb-complete-mail-hook nil
"List of functions called after a sucessful completion."
:group 'bbdb-sendmail
:type 'hook)
(defcustom bbdb-mail-abbrev-expand-hook nil
;; Replacement for function `mail-abbrev-expand-hook'.
"Function (not hook) run each time an alias is expanded.
The function is called with two args the alias and the list
of corresponding mail addresses."
:group 'bbdb-sendmail
:type 'function)
(defcustom bbdb-completion-display-record t
"If non-nil `bbdb-complete-mail' displays the BBDB record after completion."
:group 'bbdb-sendmail
:type '(choice (const :tag "Update the BBDB buffer" t)
(const :tag "Do not update the BBDB buffer" nil)))
;;;Dialing
(defcustom bbdb-dial-local-prefix-alist
'(((if (integerp bbdb-default-area-code)
(format "(%03d)" bbdb-default-area-code)
(or bbdb-default-area-code ""))
. ""))
"Mapping to remove local prefixes from numbers.
If this is non-nil, it should be an alist of
\(PREFIX . REPLACEMENT) elements. The first part of a phone number
matching the regexp returned by evaluating PREFIX will be replaced by
the corresponding REPLACEMENT when dialing."
:group 'bbdb-utilities-dialing
:type 'sexp)
(defcustom bbdb-dial-local-prefix nil
"Local prefix digits.
If this is non-nil, it should be a string of digits which your phone
system requires before making local calls (for example, if your phone system
requires you to dial 9 before making outside calls.) In BBDB's
opinion, you're dialing a local number if it starts with a 0 after
processing `bbdb-dial-local-prefix-alist'."
:group 'bbdb-utilities-dialing
:type '(choice (const :tag "No digits required" nil)
(string :tag "Dial this first" "9")))
(defcustom bbdb-dial-long-distance-prefix nil
"Long distance prefix digits.
If this is non-nil, it should be a string of digits which your phone
system requires before making a long distance call (one not in your local
area code). For example, in some areas you must dial 1 before an area
code. Note that this is used to replace the + sign in phone numbers
when dialling (international dialing prefix.)"
:group 'bbdb-utilities-dialing
:type '(choice (const :tag "No digits required" nil)
(string :tag "Dial this first" "1")))
(defcustom bbdb-dial-function nil
"If non-nil this should be a function used for dialing phone numbers.
This function is used by `bbdb-dial-number'. It requires one
argument which is a string for the number that is dialed.
If nil then `bbdb-dial-number' uses the tel URI syntax passed to `browse-url'
to make the call."
:group 'bbdb-utilities-dialing
:type 'function)
;; Faces for font-lock
(defgroup bbdb-faces nil
"Faces used by BBDB."
:group 'bbdb
:group 'faces)
(defface bbdb-name
'((t (:inherit font-lock-function-name-face)))
"Face used for BBDB names."
:group 'bbdb-faces)
;; KEY needs to match the value of the xfield name-face, which is a string.
;; To avoid confusion, we make KEY a string, too, though symbols might be
;; faster.
(defcustom bbdb-name-face-alist nil
"Alist used for font-locking the name of a record.
Each element should be a cons cell (KEY . FACE) with string KEY and face FACE.
To use FACE for font-locking the name of a record,
the xfield name-face of this record should have the value KEY.
The value of name-face may also be a face which is then used directly.
If none of these schemes succeeds, the face `bbdb-name' is used."
:group 'bbdb-faces
:type '(repeat (cons (symbol :tag "Key") (face :tag "Face"))))
(defface bbdb-organization
'((t (:inherit font-lock-comment-face)))
"Face used for BBDB names."
:group 'bbdb-faces)
(defface bbdb-field-name
'((t (:inherit font-lock-variable-name-face)))
"Face used for BBDB names."
:group 'bbdb-faces)
;;; Internal variables
(eval-and-compile
(defvar bbdb-debug t
"Enable debugging if non-nil during compile time.
You really should not disable debugging. But it will speed things up."))
(defconst bbdb-file-format 7
"BBDB file format.")
(defconst bbdb-record-type
'(vector (or string (const nil)) ; first name
(or string (const nil)) ; last name
(repeat string) ; affix
(repeat string) ; aka
(repeat string) ; organization
(repeat (or (vector string string)
(vector string integer integer integer integer))) ; phone
(repeat (vector string (repeat string) string string
string string)) ; address
(repeat string) ; mail
(repeat (cons symbol sexp)) ; xfields
sexp) ; cache
"Pseudo-code for the structure of a record. Used by `bbdb-record-type'.")
(defconst bbdb-file-coding-system 'utf-8
"Coding system used for reading and writing `bbdb-file'.")
(defvar bbdb-mail-aliases-need-rebuilt nil
"Non-nil if mail aliases need to be rebuilt.")
(defvar bbdb-need-to-sort nil
"Non-nil if records require sorting after editing.")
(defvar bbdb-buffer nil "Buffer visiting `bbdb-file'.")
(defvar bbdb-buffer-name "*BBDB*" "Name of the BBDB buffer.")
(defvar bbdb-silent-internal nil
"Bind this to t to quiet things down - do not set it.
See also `bbdb-silent'.")
(defvar bbdb-init-forms
'((gnus ; gnus 3.15 or newer
(add-hook 'gnus-startup-hook 'bbdb-insinuate-gnus))
(mh-e ; MH-E
(add-hook 'mh-folder-mode-hook 'bbdb-insinuate-mh))
(rmail ; RMAIL
(add-hook 'rmail-mode-hook 'bbdb-insinuate-rmail))
(vm ; newer versions of vm do not have `vm-load-hook'
(eval-after-load "vm" '(bbdb-insinuate-vm)))
(mail ; the standard mail user agent
(add-hook 'mail-setup-hook 'bbdb-insinuate-mail))
(sendmail
(progn (message "BBDB: sendmail insinuation deprecated. Use mail.")
(add-hook 'mail-setup-hook 'bbdb-insinuate-mail)))
(message ; the gnus mail user agent
(add-hook 'message-setup-hook 'bbdb-insinuate-message))
(mu4e ; the mu4e user agent
(add-hook 'mu4e-main-mode-hook 'bbdb-insinuate-mu4e))
(sc ; supercite
(add-hook 'sc-load-hook 'bbdb-insinuate-sc))
(anniv ; anniversaries
(add-hook 'diary-list-entries-hook 'bbdb-anniv-diary-entries))
(pgp ; pgp-mail
(progn
(add-hook 'message-send-hook 'bbdb-pgp)
(add-hook 'mail-send-hook 'bbdb-pgp))))
"Alist mapping features to insinuation forms.")
(defvar bbdb-search-invert nil
"Bind this variable to t in order to invert the result of `bbdb-search'.")
(defvar bbdb-do-all-records nil
"Controls the behavior of the command `bbdb-do-all-records'.")
(defvar bbdb-append-display nil
"Controls the behavior of the command `bbdb-append-display'.")
(defvar bbdb-offer-to-create nil
"For communication between `bbdb-update-records' and `bbdb-query-create'.")
(defvar bbdb-update-records-address nil
"For communication between `bbdb-update-records' and `bbdb-query-create'.
It is a list with elements (NAME MAIL HEADER HEADER-CLASS MUA).")
;;; Buffer-local variables for the database.
(defvar bbdb-records nil
"BBDB records list.
In buffer `bbdb-file' this list includes all records.
In the *BBDB* buffers it includes the records that are actually displayed
and its elements are (RECORD DISPLAY-FORMAT MARKER-POS).")
(make-variable-buffer-local 'bbdb-records)
(defvar bbdb-changed-records nil
"List of records that has been changed since BBDB was last saved.
Use `bbdb-search-changed' to display these records.")
(defvar bbdb-end-marker nil
"Marker holding the buffer position of the end of the last record.")
;; The value 127 is an arbitrary prime number.
;; see elisp:Creating Symbols
(defvar bbdb-hashtable (make-vector 127 0)
"Hash table for BBDB records.
Hashes the fields first-last-name, last-first-name, organization, aka,
and mail. In elisp lingo, this is really an obarray.")
(defvar bbdb-xfield-label-list nil
"List of labels for xfields.")
(defvar bbdb-organization-list nil
"List of organizations known to BBDB.")
(defvar bbdb-street-list nil
"List of streets known to BBDB.")
(defvar bbdb-city-list nil
"List of cities known to BBDB.")
(defvar bbdb-state-list nil
"List of states known to BBDB.")
(defvar bbdb-postcode-list nil
"List of post codes known to BBDB.")
(defvar bbdb-country-list nil
"List of countries known to BBDB.")
(defvar bbdb-modeline-info (make-vector 6 nil)
"Precalculated mode line info for BBDB commands.
This is a vector [APPEND-M APPEND INVERT-M INVERT ALL-M ALL].
APPEND-M is the mode line info if `bbdb-append-display' is non-nil.
INVERT-M is the mode line info if `bbdb-search-invert' is non-nil.
ALL-M is the mode line info if `bbdb-do-all-records' is non-nil.
APPEND, INVERT, and ALL appear in the message area.")
(defvar bbdb-update-unchanged-records nil
"If non-nil update unchanged records in the database.
Normally calls of `bbdb-change-hook' and updating of a record are suppressed,
if an editing command did not really change the record. Bind this to t
if you want to call `bbdb-change-hook' and update the record unconditionally.")
;;; Keymap
(defvar bbdb-mode-map
(let ((km (make-sparse-keymap)))
(define-key km "*" 'bbdb-do-all-records)
(define-key km "+" 'bbdb-append-display)
(define-key km "!" 'bbdb-search-invert)
(define-key km "a" 'bbdb-add-mail-alias)
(define-key km "A" 'bbdb-mail-aliases)
(define-key km "c" 'bbdb-create)
(define-key km "e" 'bbdb-edit-field)
(define-key km ";" 'bbdb-edit-foo)
(define-key km "n" 'bbdb-next-record)
(define-key km "p" 'bbdb-prev-record)
(define-key km "N" 'bbdb-next-field)
(define-key km "\t" 'bbdb-next-field) ; TAB
(define-key km "P" 'bbdb-prev-field)
(define-key km "\d" 'bbdb-prev-field) ; DEL
(define-key km "d" 'bbdb-delete-field-or-record)
(define-key km "\C-k" 'bbdb-delete-field-or-record)
(define-key km "i" 'bbdb-insert-field)
(define-key km "s" 'bbdb-save)
(define-key km "\C-x\C-s" 'bbdb-save)
(define-key km "t" 'bbdb-toggle-records-layout)
(define-key km "T" 'bbdb-display-records-completely)
(define-key km "o" 'bbdb-omit-record)
(define-key km "m" 'bbdb-mail)
(define-key km "M" 'bbdb-mail-address)
(define-key km "\M-d" 'bbdb-dial)
(define-key km "h" 'bbdb-info)
(define-key km "?" 'bbdb-help)
;; (define-key km "q" 'quit-window) ; part of `special-mode' bindings
(define-key km "\C-x\C-t" 'bbdb-transpose-fields)
(define-key km "Cr" 'bbdb-copy-records-as-kill)
(define-key km "Cf" 'bbdb-copy-fields-as-kill)
(define-key km "u" 'bbdb-browse-url)
;; (define-key km "P" 'bbdb-print)
(define-key km "=" 'delete-other-windows)
;; Search keys
(define-key km "b" 'bbdb)
(define-key km "/1" 'bbdb-display-records)
(define-key km "/n" 'bbdb-search-name)
(define-key km "/o" 'bbdb-search-organization)
(define-key km "/p" 'bbdb-search-phone)
(define-key km "/a" 'bbdb-search-address)
(define-key km "/m" 'bbdb-search-mail)
(define-key km "/N" 'bbdb-search-xfields)
(define-key km "/x" 'bbdb-search-xfields)
(define-key km "/c" 'bbdb-search-changed)
(define-key km "/d" 'bbdb-search-duplicates)
(define-key km "\C-xnw" 'bbdb-display-all-records)
(define-key km "\C-xnd" 'bbdb-display-current-record)
(define-key km [delete] 'scroll-down) ; 24.1: part of `special-mode'
(define-key km " " 'scroll-up) ; 24.1: part of `special-mode'
(define-key km [mouse-3] 'bbdb-mouse-menu)
(define-key km [mouse-2] (lambda (event)
;; Toggle record layout
(interactive "e")
(save-excursion
(posn-set-point (event-end event))
(bbdb-toggle-records-layout
(bbdb-do-records t) current-prefix-arg))))
km)
"Keymap for Insidious Big Brother Database.
This is a child of `special-mode-map'.")
(easy-menu-define
bbdb-menu bbdb-mode-map "BBDB Menu"
'("BBDB"
("Display"
["Previous field" bbdb-prev-field t]
["Next field" bbdb-next-field t]
["Previous record" bbdb-prev-record t]
["Next record" bbdb-next-record t]
"--"
["Show all records" bbdb-display-all-records t]
["Show current record" bbdb-display-current-record t]
["Omit record" bbdb-omit-record t]
"--"
["Toggle layout" bbdb-toggle-records-layout t]
["Show all fields" bbdb-display-records-completely t])
("Searching"
["General search" bbdb t]
["Search one record" bbdb-display-records t]
["Search name" bbdb-search-name t]
["Search organization" bbdb-search-organization t]
["Search phone" bbdb-search-phone t]
["Search address" bbdb-search-address t]
["Search mail" bbdb-search-mail t]
["Search xfields" bbdb-search-xfields t]
["Search changed records" bbdb-search-changed t]
["Search duplicates" bbdb-search-duplicates t]
"--"
["Old time stamps" bbdb-timestamp-older t]
["New time stamps" bbdb-timestamp-newer t]
["Old creation date" bbdb-creation-older t]
["New creation date" bbdb-creation-newer t]
["Creation date = time stamp" bbdb-creation-no-change t]
"--"
["Append search" bbdb-append-display t]
["Invert search" bbdb-search-invert t])
("Mail"
["Send mail" bbdb-mail t]
["Save mail address" bbdb-mail-address t]
"--"
["Add mail alias" bbdb-add-mail-alias t]
["(Re-)Build mail aliases" bbdb-mail-aliases t])
("Use database"
["Prefix: do all records" bbdb-do-all-records t]
"--"
["Send mail" bbdb-mail t]
["Dial phone number" bbdb-dial t]
["Browse URL" bbdb-browse-url t]
["Copy records as kill" bbdb-copy-records-as-kill t]
["Copy fields as kill" bbdb-copy-fields-as-kill t]
"--"
["Print records" bbdb-print t])
("Manipulate database"
["Prefix: do all records" bbdb-do-all-records t]
"--"
["Create new record" bbdb-create t]
["Edit current field" bbdb-edit-field t]
["Insert new field" bbdb-insert-field t]
["Edit some field" bbdb-edit-foo t]
["Transpose fields" bbdb-transpose-fields t]
["Delete record or field" bbdb-delete-field-or-record t]
"--"
["Sort addresses" bbdb-sort-addresses t]
["Sort phones" bbdb-sort-phones t]
["Sort xfields" bbdb-sort-xfields t]
["Merge records" bbdb-merge-records t]
["Sort database" bbdb-sort-records t]
["Delete duplicate mails" bbdb-delete-redundant-mails t]
"--"
["Save BBDB" bbdb-save t]
["Revert BBDB" revert-buffer t])
("Help"
["Brief help" bbdb-help t]
["BBDB Manual" bbdb-info t])
"--"
["Quit" quit-window t]))
(defvar bbdb-completing-read-mails-map
(let ((map (copy-keymap minibuffer-local-completion-map)))
(define-key map " " 'self-insert-command)
(define-key map "\t" 'bbdb-complete-mail)
(define-key map "\M-\t" 'bbdb-complete-mail)
map)
"Keymap used by `bbdb-completing-read-mails'.")
;;; Helper functions
(defun bbdb-warn (&rest args)
"Display a message at the bottom of the screen.
ARGS are passed to `message'."
(ding t)
(apply 'message args))
(defun bbdb-string-trim (string &optional null)
"Remove leading and trailing whitespace and all properties from STRING.
If STRING is nil return an empty string unless NULL is non-nil."
(if (null string)
(unless null "")
(setq string (substring-no-properties string))
(if (string-match "\\`[ \t\n]+" string)
(setq string (substring-no-properties string (match-end 0))))
(if (string-match "[ \t\n]+\\'" string)
(setq string (substring-no-properties string 0 (match-beginning 0))))
(unless (and null (string= "" string))
string)))
(defsubst bbdb-string= (str1 str2)
"Return t if strings STR1 and STR2 are equal, ignoring case."
(and (stringp str1) (stringp str2)
(eq t (compare-strings str1 0 nil str2 0 nil t))))
(defun bbdb-split (separator string)
"Split STRING into list of substrings bounded by matches for SEPARATORS.
SEPARATOR may be a regexp. SEPARATOR may also be a symbol
\(a field name). Then look up the value in `bbdb-separator-alist'
or use `bbdb-default-separator'.
Whitespace around SEPARATOR is ignored unless SEPARATOR matches
the string \" \\t\\n\".
Almost the inverse function of `bbdb-concat'."
(if (symbolp separator)
(setq separator (car (or (cdr (assq separator bbdb-separator-alist))
bbdb-default-separator))))
(unless (string-match separator " \t\n")
(setq separator (concat "[ \t\n]*" separator "[ \t\n]*")))
;; `split-string' applied to an empty STRING gives nil.
(split-string (bbdb-string-trim string) separator t))
(defun bbdb-concat (separator &rest strings)
"Concatenate STRINGS to a string sticking in SEPARATOR.
STRINGS may be strings or lists of strings. Empty strings are ignored.
SEPARATOR may be a string.
SEPARATOR may also be a symbol (a field name). Then look up the value
of SEPARATOR in `bbdb-separator-alist' or use `bbdb-default-separator'.
The inverse function of `bbdb-split'."
(if (symbolp separator)
(setq separator (nth 1 (or (cdr (assq separator bbdb-separator-alist))
bbdb-default-separator))))
(mapconcat 'identity
(delete "" (apply 'append (mapcar (lambda (x) (if (stringp x)
(list x) x))
strings))) separator))
(defun bbdb-list-strings (list)
"Remove all elements from LIST which are not non-empty strings."
(let (new-list)
(dolist (elt list)
(if (and (stringp elt) (not (string= "" elt)))
(push elt new-list)))
(nreverse new-list)))
;; A call of `indent-region' swallows any indentation
;; that might be part of the field itself. So we indent manually.
(defsubst bbdb-indent-string (string column)
"Indent nonempty lines in STRING to COLUMN (except first line).
This happens in addition to any pre-defined indentation of STRING."
(replace-regexp-in-string "\n\\([^\n]\\)"
(concat "\n" (make-string column ?\s) "\\1")
string))
(defun bbdb-read-string (prompt &optional init collection require-match)
"Read a string, trimming whitespace and text properties.
PROMPT is a string to prompt with.
INIT appears as initial input which is useful for editing existing records.
COLLECTION and REQUIRE-MATCH have the same meaning as in `completing-read'."
(bbdb-string-trim
(if collection
;; Hack: In `minibuffer-local-completion-map' remove
;; the binding of SPC to `minibuffer-complete-word'
;; and of ? to `minibuffer-completion-help'.
(minibuffer-with-setup-hook
(lambda ()
(use-local-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map (current-local-map))
(define-key map " " nil)
(define-key map "?" nil)
map)))
(completing-read prompt collection nil require-match init))
(read-string prompt init))))
(defun bbdb-add-to-list (list-var element)
"Add ELEMENT to the value of LIST-VAR if it isn't there yet and non-nil.
The test for presence of ELEMENT is done with `equal'.
The return value is the new value of LIST-VAR."
(if (or (not element)
(member element (symbol-value list-var)))
(symbol-value list-var)
(set list-var (cons element (symbol-value list-var)))))
(defun bbdb-current-record (&optional full)
"Return the record point is at.
If FULL is non-nil record includes the display information."
(unless (eq major-mode 'bbdb-mode)
(error "This only works while in BBDB buffers."))
(let ((num (get-text-property (if (and (not (bobp)) (eobp))
(1- (point)) (point))
'bbdb-record-number))
record)
(unless num (error "Not a BBDB record"))
(setq record (nth num bbdb-records))
(if full record (car record))))
(defun bbdb-current-field ()
"Return current field point is on."
(unless (bbdb-current-record) (error "Not a BBDB record"))
(get-text-property (point) 'bbdb-field))
(defmacro bbdb-debug (&rest body)
"Excecute BODY just like `progn' with debugging capability.
Debugging is enabled if variable `bbdb-debug' is non-nil during compile.
You really should not disable debugging. But it will speed things up."
(declare (indent 0))
(if bbdb-debug ; compile-time switch
`(let ((debug-on-error t))
,@body)))
;; inspired by `gnus-bind-print-variables'
(defmacro bbdb-with-print-loadably (&rest body)
"Bind print-* variables for BBDB and evaluate BODY.
This macro is used with `prin1', `prin1-to-string', etc. in order to ensure
printed Lisp objects are loadable by BBDB."
(declare (indent 0))
`(let ((print-escape-newlines t) ;; BBDB needs this!
print-escape-nonascii print-escape-multibyte
print-quoted print-length print-level)
;; print-circle print-gensym
;; print-continuous-numbering
;; print-number-table
;; float-output-format
,@body))
(defun bbdb-timestamp (record)
"For use as an element of `bbdb-change-hook'.
Maintains an xfield `timestamp' for RECORD which contains
the time when it was last modified. If such a field already exists,
it is changed, otherwise it is added."
(bbdb-record-set-xfield record 'timestamp
(format-time-string bbdb-time-stamp-format nil t)))
(defun bbdb-creation-date (record)
"For use as an element of `bbdb-create-hook'.
Adds an xfield `creation-date' for RECORD which is the current time string."
(bbdb-record-set-xfield record 'creation-date
(format-time-string bbdb-time-stamp-format nil t)))
(defun bbdb-multiple-buffers-default ()
"Default function for guessing a name for new *BBDB* buffers.
May be used as value of variable `bbdb-multiple-buffers'."
(save-current-buffer
(cond ((memq major-mode '(vm-mode vm-summary-mode vm-presentation-mode
vm-virtual-mode))
(vm-select-folder-buffer)
(buffer-name))
((memq major-mode '(gnus-summary-mode gnus-group-mode))
(set-buffer gnus-article-buffer)
(buffer-name))
((memq major-mode '(mail-mode vm-mail-mode message-mode))
"message composition"))))
(defsubst bbdb-add-job (spec record string)
"Internal function: Evaluate SPEC for RECORD and STRING.
If SPEC is a function call it with args RECORD and STRING. Return value.
If SPEC is a regexp, return 'query unless SPEC matches STRING.
Otherwise return SPEC.
Used with variable `bbdb-add-name' and friends."
(cond ((functionp spec)
(funcall spec record string))
((stringp spec)
(unless (string-match spec string) 'query)) ; be least aggressive
(spec)))
(defsubst bbdb-eval-spec (spec prompt)
"Internal function: Evaluate SPEC using PROMPT.
Return t if either SPEC equals t, or SPEC equals 'query and `bbdb-silent'
is non-nil or `y-or-no-p' returns t using PROMPT.
Used with return values of `bbdb-add-job'."
(or (eq spec t)
(and (eq spec 'query)
(or bbdb-silent (y-or-n-p prompt)))))
(defun bbdb-clean-address-components (components)
"Clean mail address COMPONENTS.
COMPONENTS is a list (FULL-NAME CANONICAL-ADDRESS) as returned
by `mail-extract-address-components'.
Pass FULL-NAME through `bbdb-message-clean-name-function'
and CANONICAL-ADDRESS through `bbdb-canonicalize-mail-function'."
(list (if (car components)
(if bbdb-message-clean-name-function
(funcall bbdb-message-clean-name-function (car components))
(car components)))
(if (cadr components)
(if bbdb-canonicalize-mail-function
(funcall bbdb-canonicalize-mail-function (cadr components))
;; Minimalistic clean-up
(bbdb-string-trim (cadr components))))))
(defun bbdb-extract-address-components (address &optional all)
"Given an RFC-822 address ADDRESS, extract full name and canonical address.
This function behaves like `mail-extract-address-components', but it passes
its return value through `bbdb-clean-address-components'.
See also `bbdb-decompose-bbdb-address'."
(if all
(mapcar 'bbdb-clean-address-components
(mail-extract-address-components address t))
(bbdb-clean-address-components (mail-extract-address-components address))))
;; Inspired by `gnus-extract-address-components' from gnus-utils.
(defun bbdb-decompose-bbdb-address (mail)
"Given an RFC-822 address MAIL, extract full name and canonical address.
In general, this function behaves like the more sophisticated function
`mail-extract-address-components'. Yet for an address `<Joe_Smith@foo.com>'
lacking a real name the latter function returns the name \"Joe Smith\".
This is useful when analyzing the headers of email messages we receive
from the outside world. Yet when analyzing the mail addresses stored
in BBDB, this pollutes the mail-aka space. So we define here
an intentionally much simpler function for decomposing the names
and canonical addresses in the mail field of BBDB records."
(let (name address)
;; First find the address - the thing with the @ in it.
(cond (;; Check `<foo@bar>' first in order to handle the quite common
;; form `"abc@xyz" <foo@bar>' (i.e. `@' as part of a comment)
;; correctly.
(string-match "<\\([^@ \t<>]+[!@][^@ \t<>]+\\)>" mail)
(setq address (match-string 1 mail)))
((string-match "\\b[^@ \t<>]+[!@][^@ \t<>]+\\b" mail)
(setq address (match-string 0 mail))))
;; Then check whether the `name <address>' format is used.
(and address
;; Linear white space is not required.
(string-match (concat "[ \t]*<" (regexp-quote address) ">") mail)
(setq name (substring mail 0 (match-beginning 0)))
;; Strip any quotes mail the name.
(string-match "^\".*\"$" name)
(setq name (substring name 1 (1- (match-end 0)))))
;; If not, then check whether the `address (name)' format is used.
(or name
(and (string-match "(\\([^)]+\\))" mail)
(setq name (match-string 1 mail))))
(list (if (equal name "") nil name) (or address mail))))
;;; Massage of mail addresses
(defcustom bbdb-canonical-hosts
;; Example
(regexp-opt '("cs.cmu.edu" "ri.cmu.edu"))
"Regexp matching the canonical part of the domain part of a mail address.
If the domain part of a mail address matches this regexp, the domain
is replaced by the substring that actually matched this address.
Used by `bbdb-canonicalize-mail-1'. See also `bbdb-ignore-redundant-mails'."
:group 'bbdb-mua
:type '(regexp :tag "Regexp matching sites"))
(defun bbdb-canonicalize-mail-1 (address)
"Example of `bbdb-canonicalize-mail-function'.
However, this function is too specific to be useful for the general user.
Take it as a source of inspiration for what can be done."
(setq address (bbdb-string-trim address))
(cond
;; Rewrite mail-drop hosts.
;; RW: The following is now also handled by `bbdb-ignore-redundant-mails'
((string-match
(concat "\\`\\([^@%!]+@\\).*\\.\\(" bbdb-canonical-hosts "\\)\\'")
address)
(concat (match-string 1 address) (match-string 2 address)))
;;
;; Here at Lucid, our workstation names sometimes get into our mail
;; addresses in the form "jwz%thalidomide@lucid.com" (instead of simply
;; "jwz@lucid.com"). This removes the workstation name.
((string-match "\\`\\([^@%!]+\\)%[^@%!.]+@\\(lucid\\.com\\)\\'" address)
(concat (match-string 1 address) "@" (match-string 2 address)))
;;
;; Another way that our local mailer is misconfigured: sometimes addresses
;; which should look like "user@some.outside.host" end up looking like
;; "user%some.outside.host" or even "user%some.outside.host@lucid.com"
;; instead. This rule rewrites it into the original form.
((string-match "\\`\\([^@%]+\\)%\\([^@%!]+\\)\\(@lucid\\.com\\)?\\'" address)
(concat (match-string 1 address) "@" (match-string 2 address)))
;;
;; Sometimes I see addresses like "foobar.com!user@foobar.com".
;; That's totally redundant, so this rewrites it as "user@foobar.com".
((string-match "\\`\\([^@%!]+\\)!\\([^@%!]+[@%]\\1\\)\\'" address)
(match-string 2 address))
;;
;; Sometimes I see addresses like "foobar.com!user". Turn it around.
((string-match "\\`\\([^@%!.]+\\.[^@%!]+\\)!\\([^@%]+\\)\\'" address)
(concat (match-string 2 address) "@" (match-string 1 address)))
;;
;; The mailer at hplb.hpl.hp.com tends to puke all over addresses which
;; pass through mailing lists which are maintained there: it turns normal
;; addresses like "user@foo.com" into "user%foo.com@hplb.hpl.hp.com".
;; This reverses it. (I actually could have combined this rule with
;; the similar lucid.com rule above, but then the regexp would have been
;; more than 80 characters long...)
((string-match "\\`\\([^@!]+\\)%\\([^@%!]+\\)@hplb\\.hpl\\.hp\\.com\\'"
address)
(concat (match-string 1 address) "@" (match-string 2 address)))
;;
;; Another local mail-configuration botch: sometimes mail shows up
;; with addresses like "user@workstation", where "workstation" is a
;; local machine name. That should really be "user" or "user@netscape.com".
;; (I'm told this one is due to a bug in SunOS 4.1.1 sendmail.)
((string-match "\\`\\([^@%!]+\\)[@%][^@%!.]+\\'" address)
(match-string 1 address))
;;
;; Sometimes I see addresses like "foo%somewhere%uunet.uu.net@somewhere.else".
;; This is silly, because I know that I can send mail to uunet directly.
((string-match ".%uunet\\.uu\\.net@[^@%!]+\\'" address)
(concat (substring address 0 (+ (match-beginning 0) 1)) "@UUNET.UU.NET"))
;;
;; Otherwise, leave it as it is.
(t address)))
(defun bbdb-message-clean-name-default (name)
"Default function for `bbdb-message-clean-name-function'.
This strips garbage from the user full NAME string."
;; Remove leading non-alpha chars
(if (string-match "\\`[^[:alpha:]]+" name)
(setq name (substring name (match-end 0))))
(if (string-match "^\\([^@]+\\)@" name)
;; The name is really a mail address and we use the part preceeding "@".
;; Everything following "@" is ignored.
(setq name (match-string 1 name)))
;; Replace "firstname.surname" by "firstname surname".
;; Do not replace ". " with " " because that could be an initial.
(setq name (replace-regexp-in-string "\\.\\([^ ]\\)" " \\1" name))
;; Replace tabs, spaces, and underscores with a single space.
(setq name (replace-regexp-in-string "[ \t\n_]+" " " name))
;; Remove trailing comments separated by "(" or " [-#]"
;; This does not work all the time because some of our friends in
;; northern europe have brackets in their names...
(if (string-match "[^ \t]\\([ \t]*\\((\\| [-#]\\)\\)" name)
(setq name (substring name 0 (match-beginning 1))))
;; Remove phone extensions (like "x1234" and "ext. 1234")
(let ((case-fold-search t))
(setq name (replace-regexp-in-string
"\\W+\\(x\\|ext\\.?\\)\\W*[-0-9]+" "" name)))
;; Remove trailing non-alpha chars
(if (string-match "[^[:alpha:]]+\\'" name)
(setq name (substring name 0 (match-beginning 0))))
;; Remove text properties
(substring-no-properties name))
;; BBDB data structure
(defmacro bbdb-defstruct (name &rest elts)
"Define two functions to operate on vector NAME for each symbol ELT in ELTS.
The function bbdb-NAME-ELT returns the element ELT in vector NAME.
The function bbdb-NAME-set-ELT sets ELT.
Also define a constant bbdb-NAME-length that holds the number of ELTS
in vector NAME."
(declare (indent 1))
(let* ((count 0)
(sname (symbol-name name))
(uname (upcase sname))
(cname (concat "bbdb-" sname "-"))
body)
(dolist (elt elts)
(let* ((selt (symbol-name elt))
(setname (intern (concat cname "set-" selt))))
(push (list 'defsubst (intern (concat cname selt)) `(,name)
(format "For BBDB %s read element %i `%s'."
uname count selt)
;; Use `elt' instead of `aref' so that these functions
;; also work for the `bbdb-record-type' pseudo-code.
`(elt ,name ,count)) body)
(push (list 'defsubst setname `(,name value)
(format "For BBDB %s set element %i `%s' to VALUE. \
Return VALUE.
Do not call this function directly. Call instead `bbdb-record-set-field'
which ensures the integrity of the database. Also, this makes your code
more robust with respect to possible future changes of BBDB's innermost
internals."
uname count selt)
`(aset ,name ,count value)) body))
(setq count (1+ count)))
(push (list 'defconst (intern (concat cname "length")) count
(concat "Length of BBDB `" sname "'.")) body)
(cons 'progn body)))
;; Define RECORD:
(bbdb-defstruct record
firstname lastname affix aka organization phone address mail xfields cache)
;; Define PHONE:
(bbdb-defstruct phone
label area exchange suffix extension)
;; Define ADDRESS:
(bbdb-defstruct address
label streets city state postcode country)
;; Define record CACHE:
;; - fl-name (first and last name of the person referred to by the record),
;; - lf-name (last and first name of the person referred to by the record),
;; - mail-aka (list of names associated with mail addresses)
;; - mail-canon (list of canonical mail addresses)
;; - sortkey (the concatenation of the elements used for sorting the record),
;; - marker (position of beginning of record in `bbdb-file')
(bbdb-defstruct cache
fl-name lf-name mail-aka mail-canon sortkey marker)
(defsubst bbdb-record-mail-aka (record)
"Record cache function: Return mail-aka for RECORD."
(bbdb-cache-mail-aka (bbdb-record-cache record)))
(defsubst bbdb-record-mail-canon (record)
"Record cache function: Return mail-canon for RECORD."
(bbdb-cache-mail-canon (bbdb-record-cache record)))
(defun bbdb-empty-record ()
"Return a new empty record structure with a cache.
It is the caller's responsibility to make the new record known to BBDB."
(let ((record (make-vector bbdb-record-length nil)))
(bbdb-record-set-cache record (make-vector bbdb-cache-length nil))
record))
;; `bbdb-hashtable' associates with each KEY a list of matching records.
;; KEY includes fl-name, lf-name, organizations, AKAs and email addresses.
;; When loading the database the hash table is initialized by calling
;; `bbdb-hash-record' for each record. This function is also called
;; when new records are added to the database.
;; `bbdb-delete-record-internal' with arg REMHASH non-nil removes a record
;; from the hash table (besides deleting the record from the database).
;; When an existing record is modified, the code that modifies the record
;; needs to update the hash table, too. This includes removing the outdated
;; associations between KEYs and record as well as adding the new associations.
;; The hash table can be accessed via `bbdb-gethash'
;; and via functions like `completing-read'.
(defun bbdb-puthash (key record)
"Associate RECORD with KEY in `bbdb-hashtable'.
KEY must be a string or nil. Empty strings and nil are ignored."
(if (and key (not (string= "" key))) ; do not hash empty strings
(let ((sym (intern (downcase key) bbdb-hashtable)))
(if (boundp sym)
(add-to-list sym record nil 'eq)
(set sym (list record))))))
(defun bbdb-gethash (key &optional predicate)
"Return list of records associated with KEY in `bbdb-hashtable'.
KEY must be a string or nil. Empty strings and nil are ignored.
PREDICATE may take the same values as `bbdb-completion-list'."
(when (and key (not (string= "" key)))
(let* ((key (downcase key))
(all-records (symbol-value (intern-soft key bbdb-hashtable)))
records)
(if (or (not predicate) (eq t predicate))
all-records
(dolist (record all-records)
(if (catch 'bbdb-hash-ok
(bbdb-hash-p key record predicate))
(push record records)))
records))))
(defun bbdb-hash-p (key record predicate)
"Throw `bbdb-hash-ok' non-nil if KEY matches RECORD acording to PREDICATE.
PREDICATE may take the same values as the elements of `bbdb-completion-list'."
(if (and (memq 'fl-name predicate)
(bbdb-string= key (or (bbdb-record-name record) "")))
(throw 'bbdb-hash-ok 'fl-name))
(if (and (memq 'lf-name predicate)
(bbdb-string= key (or (bbdb-record-name-lf record) "")))
(throw 'bbdb-hash-ok 'lf-name))
(if (memq 'organization predicate)
(mapc (lambda (organization) (if (bbdb-string= key organization)
(throw 'bbdb-hash-ok 'organization)))
(bbdb-record-organization record)))
(if (memq 'aka predicate)
(mapc (lambda (aka) (if (bbdb-string= key aka)
(throw 'bbdb-hash-ok 'aka)))
(bbdb-record-field record 'aka-all)))
(if (and (memq 'primary predicate)
(bbdb-string= key (car (bbdb-record-mail-canon record))))
(throw 'bbdb-hash-ok 'primary))
(if (memq 'mail predicate)
(mapc (lambda (mail) (if (bbdb-string= key mail)
(throw 'bbdb-hash-ok 'mail)))
(bbdb-record-mail-canon record)))
nil)
(defun bbdb-remhash (key record)
"Remove RECORD from list of records associated with KEY.
KEY must be a string or nil. Empty strings and nil are ignored."
(if (and key (not (string= "" key)))
(let ((sym (intern-soft (downcase key) bbdb-hashtable)))
(if sym
(let ((val (delq record (symbol-value sym))))
(if val
(set sym val)
(unintern sym bbdb-hashtable)))))))
(defun bbdb-hash-record (record)
"Insert RECORD in `bbdb-hashtable'.
This performs all initializations required for a new record.
Do not call this for existing records that require updating."
(bbdb-puthash (bbdb-record-name record) record)
(bbdb-puthash (bbdb-record-name-lf record) record)
(dolist (organization (bbdb-record-organization record))
(bbdb-puthash organization record))
(dolist (aka (bbdb-record-aka record))
(bbdb-puthash aka record))
(bbdb-puthash-mail record))
(defun bbdb-puthash-mail (record)
"For RECORD put mail into `bbdb-hashtable'."
(let (mail-aka mail-canon address)
(dolist (mail (bbdb-record-mail record))
(setq address (bbdb-decompose-bbdb-address mail))
(when (car address)
(push (car address) mail-aka)
(bbdb-puthash (car address) record))
(push (nth 1 address) mail-canon)
(bbdb-puthash (nth 1 address) record))
(bbdb-cache-set-mail-aka (bbdb-record-cache record)
(nreverse mail-aka))
(bbdb-cache-set-mail-canon (bbdb-record-cache record)
(nreverse mail-canon))))
(defun bbdb-hash-update (record old new)
"Update hash for RECORD. Remove OLD, insert NEW.
Both OLD and NEW are lists of values."
(dolist (elt old)
(bbdb-remhash elt record))
(dolist (elt new)
(bbdb-puthash elt record)))
(defun bbdb-check-name (first last &optional record)
"Check whether the name FIRST LAST is a valid name.
This throws an error if the name is already used by another record
and `bbdb-allow-duplicates' is nil. If RECORD is non-nil, FIRST and LAST
may correspond to RECORD without raising an error."
;; Are there more useful checks for names beyond checking for duplicates?
(unless bbdb-allow-duplicates
(let* ((name (bbdb-concat 'name-first-last first last))
(records (bbdb-gethash name '(fl-name lf-name aka))))
(if (or (and (not record) records)
(remq record records))
(error "%s is already in BBDB" name)))))
(defun bbdb-record-name (record)
"Record cache function: Return the full name FIRST_LAST of RECORD.
If the name is not available in the name cache, the name cache value
is generated and stored."
(or (bbdb-cache-fl-name (bbdb-record-cache record))
;; Build the name cache for a record.
(bbdb-record-set-name record t t)))
(defun bbdb-record-name-lf (record)
"Record cache function: Return the full name LAST_FIRST of RECORD.
If the name is not available in the name cache, the name cache value
is generated and stored."
(or (bbdb-cache-lf-name (bbdb-record-cache record))
;; Build the name cache for a record.
(progn (bbdb-record-set-name record t t)
(bbdb-cache-lf-name (bbdb-record-cache record)))))
(defun bbdb-record-set-name (record first last)
"Record cache function: For RECORD set full name based on FIRST and LAST.
If FIRST or LAST are t use respective existing entries of RECORD.
Set full name in cache and hash. Also set `bbdb-need-to-sort'.
Return first-last name."
(let* ((cache (bbdb-record-cache record))
(fl-name (bbdb-cache-fl-name cache))
(lf-name (bbdb-cache-lf-name cache)))
(if fl-name (bbdb-remhash fl-name record))
(if lf-name (bbdb-remhash lf-name record)))
(if (eq t first)
(setq first (bbdb-record-firstname record))
(setq bbdb-need-to-sort
(or bbdb-need-to-sort
(not (equal first (bbdb-record-firstname record)))))
(bbdb-record-set-firstname record first))
(if (eq t last)
(setq last (bbdb-record-lastname record))
(setq bbdb-need-to-sort
(or bbdb-need-to-sort
(not (equal last (bbdb-record-lastname record)))))
(bbdb-record-set-lastname record last))
(let ((fl-name (bbdb-concat 'name-first-last first last))
(lf-name (bbdb-concat 'name-last-first last first))
(cache (bbdb-record-cache record)))
;; Set cache of RECORD
(bbdb-cache-set-fl-name cache fl-name)
(bbdb-cache-set-lf-name cache lf-name)
;; Set hash. For convenience, the hash contains the full name
;; as first-last and last-fist.
(bbdb-puthash fl-name record)
(bbdb-puthash lf-name record)
fl-name))
(defun bbdb-record-sortkey (record)
"Record cache function: Return the sortkey for RECORD.
Build and store it if necessary."
(or (bbdb-cache-sortkey (bbdb-record-cache record))
(bbdb-cache-set-sortkey (bbdb-record-cache record)
(downcase
(bbdb-concat "" (bbdb-record-lastname record)
(bbdb-record-firstname record)
(bbdb-record-organization record))))))
(defsubst bbdb-record-set-sortkey (record sortkey)
"Record cache function: Set and return RECORD's SORTKEY."
(bbdb-cache-set-sortkey (bbdb-record-cache record) sortkey))
(defsubst bbdb-record-marker (record)
"Record cache function: Return the marker for RECORD."
(bbdb-cache-marker (bbdb-record-cache record)))
(defsubst bbdb-record-set-marker (record marker)
"Record cache function: Set and return RECORD's MARKER."
(bbdb-cache-set-marker (bbdb-record-cache record) marker))
(defsubst bbdb-record-xfield (record label)
"For RECORD return value of xfield LABEL.
Return nil if xfield LABEL is undefined."
(cdr (assq label (bbdb-record-xfields record))))
;; The values of xfields are normally strings. The following function
;; comes handy if we want to treat these values as symbols.
(defun bbdb-record-xfield-intern (record label)
"For RECORD return interned value of xfield LABEL.
Return nil if xfield LABEL does not exist."
(let ((value (bbdb-record-xfield record label)))
;; If VALUE is not a string, return whatever it is.
(if (stringp value) (intern value) value)))
(defun bbdb-record-xfield-string (record label)
"For RECORD return value of xfield LABEL as string.
Return nil if xfield LABEL does not exist."
(let ((value (bbdb-record-xfield record label)))
(if (string-or-null-p value)
value
(let ((print-escape-newlines t))
(prin1-to-string value)))))
(defsubst bbdb-record-xfield-split (record label)
"For RECORD return value of xfield LABEL split as a list.
Splitting is based on `bbdb-separator-alist'."
(let ((val (bbdb-record-xfield record label)))
(cond ((stringp val) (bbdb-split label val))
(val (error "Cannot split `%s'" val)))))
(defun bbdb-record-set-xfield (record label value)
"For RECORD set xfield LABEL to VALUE.
If VALUE is nil or an empty string, remove xfield LABEL from RECORD.
Return VALUE."
;; In principle we can also have xfield labels `name' or `mail', etc.
;; Yet the actual code would get rather confused. So we throw an error.
(if (memq label '(name firstname lastname affix organization
mail aka phone address xfields))
(error "xfield label `%s' illegal" label))
(if (eq label 'mail-alias)
(setq bbdb-mail-aliases-need-rebuilt 'edit))
(if (stringp value) (setq value (bbdb-string-trim value t)))
(let ((old-xfield (assq label (bbdb-record-xfields record))))
;; Do nothing if both OLD-XFIELD and VALUE are nil.
(cond ((and old-xfield value) ; update
(setcdr old-xfield value))
(value ; new xfield
(add-to-list 'bbdb-xfield-label-list label nil 'eq)
(bbdb-record-set-xfields record
(append (bbdb-record-xfields record)
(list (cons label value)))))
(old-xfield ; remove
(bbdb-record-set-xfields record
(delq old-xfield
(bbdb-record-xfields record))))))
value)
(defun bbdb-check-type (object type &optional abort extended)
"Return non-nil if OBJECT is of type TYPE.
TYPE is a pseudo-code as in `bbdb-record-type'.
If ABORT is non-nil, abort with error message if type checking fails.
If EXTENDED is non-nil, consider extended atomic types which may include
symbols, numbers, markers, and strings."
(let (tmp)
;; Add more predicates? Compare info node `(elisp.info)Type Predicates'.
(or (cond ((eq type 'symbol) (symbolp object))
((eq type 'integer) (integerp object))
((eq type 'marker) (markerp object))
((eq type 'number) (numberp object))
((eq type 'string) (stringp object))
((eq type 'sexp) t) ; matches always
((eq type 'face) (facep object))
;; not quite a type
((eq type 'bound) (and (symbolp object) (boundp object)))
((eq type 'function) (functionp object))
((eq type 'vector) (vectorp object))
((and extended
(cond ((symbolp type) (setq tmp (eq type object)) t)
((or (numberp type) (markerp type))
(setq tmp (= type object)) t)
((stringp type)
(setq tmp (and (stringp object)
(string= type object))) t)))
tmp)
((not (consp type))
(error "Atomic type `%s' undefined" type))
((eq 'const (setq tmp (car type)))
(equal (nth 1 type) object))
((eq tmp 'cons)
(and (consp object)
(bbdb-check-type (car object) (nth 1 type) abort extended)
(bbdb-check-type (cdr object) (nth 2 type) abort extended)))
((eq tmp 'list)
(and (listp object)
(eq (length (cdr type)) (length object))
(let ((type (cdr type)) (object object) (ok t))
(while type
(unless (bbdb-check-type (pop object) (pop type)
abort extended)
(setq ok nil type nil)))
ok)))
((eq tmp 'repeat)
(and (listp object)
(let ((tp (nth 1 type)) (object object) (ok t))
(while object
(unless (bbdb-check-type (pop object) tp abort extended)
(setq ok nil object nil)))
ok)))
((eq tmp 'vector)
(and (vectorp object)
(let* ((i 0) (type (cdr type))
(ok (eq (length object) (length type))))
(when ok
(while type
(if (bbdb-check-type (aref object i) (pop type)
abort extended)
(setq i (1+ i))
(setq ok nil type nil)))
ok))))
((eq tmp 'or) ; like customize `choice' type
(let ((type (cdr type)) ok)
(while type
(if (bbdb-check-type object (pop type) nil extended)
(setq ok t type nil)))
ok))
;; User-defined predicate
((eq tmp 'user-p) (funcall (nth 1 type) object))
(t (error "Compound type `%s' undefined" tmp)))
(and abort
(error "Type mismatch: expect %s, got `%s'" type object)))))
;; (bbdb-check-type 'bar 'symbol)
;; (bbdb-check-type 'bar 'bar)
;; (bbdb-check-type "foo" 'symbol t)
;; (bbdb-check-type "foo" '(or symbol string))
;; (bbdb-check-type nil '(const nil))
;; (bbdb-check-type '(bar . "foo") '(cons symbol string))
;; (bbdb-check-type '(bar "foo") '(list symbol string))
;; (bbdb-check-type '("bar" "foo") '(repeat string))
;; (bbdb-check-type (vector 'bar "foo") '(vector symbol string))
;; (bbdb-check-type (vector 'bar "foo") 'vector)
;; (bbdb-check-type '(bar (bar . "foo")) '(list symbol (cons symbol string)))
;; (bbdb-check-type '("aa" . "bb") '(or (const nil) (cons string string)) t)
;; (bbdb-check-type nil '(or nil (cons string string)) t t)
;; (bbdb-check-type "foo" '(user-p (lambda (a) (stringp a))))
;; (bbdb-check-type 'set 'function)
(defun bbdb-record-field (record field)
"For RECORD return the value of FIELD.
FIELD may take the following values
firstname Return the first name of RECORD
lastname Return the last name of RECORD
name Return the full name of RECORD (first name first)
name-lf Return the full name of RECORD (last name first)
affix Return the list of affixes
organization Return the list of organizations
aka Return the list of AKAs
aka-all Return the list of AKAs plus mail-akas.
mail Return the list of email addresses
mail-aka Return the list of name parts in mail addresses
mail-canon Return the list of canonical mail addresses.
phone Return the list of phone numbers
address Return the list of addresses
xfields Return the list of all xfields
Any other symbol is interpreted as the label for an xfield.
Then return the value of this xfield.
See also `bbdb-record-set-field'."
(cond ((eq field 'firstname) (bbdb-record-firstname record))
((eq field 'lastname) (bbdb-record-lastname record))
((eq field 'name) (bbdb-record-name record))
((eq field 'name-lf) (bbdb-record-name-lf record))
((eq field 'affix) (bbdb-record-affix record))
((eq field 'organization) (bbdb-record-organization record))
((eq field 'mail) (bbdb-record-mail record))
((eq field 'mail-canon) (bbdb-record-mail-canon record)) ; derived (cached) field
((eq field 'mail-aka) (bbdb-record-mail-aka record)) ; derived (cached) field
((eq field 'aka) (bbdb-record-aka record))
((eq field 'aka-all) (append (bbdb-record-aka record) ; derived field
(bbdb-record-mail-aka record)))
((eq field 'phone) (bbdb-record-phone record))
((eq field 'address) (bbdb-record-address record))
;; Return all xfields
((eq field 'xfields) (bbdb-record-xfields record))
;; Return xfield FIELD (e.g., `notes') or nil if FIELD is not defined.
((symbolp field) (bbdb-record-xfield record field))
(t (error "Unknown field type `%s'" field))))
(define-obsolete-function-alias 'bbdb-record-get-field 'bbdb-record-field)
(defun bbdb-record-set-field (record field value &optional merge check)
"For RECORD set FIELD to VALUE. Return VALUE.
If MERGE is non-nil, merge VALUE with the current value of FIELD.
If CHECK is non-nil, check syntactically whether FIELD may take VALUE.
This function also updates the hash table. However, it does not update
RECORD in the database. Use `bbdb-change-record' for that.
FIELD may take the following values
firstname VALUE is the first name of RECORD
lastname VALUE is the last name of RECORD
name VALUE is the full name of RECORD either as one string
or as a cons pair (FIRST . LAST)
affix VALUE is the list of affixes
organization VALUE is the list of organizations
aka VALUE is the list of AKAs
mail VALUE is the list of email addresses
phone VALUE is the list of phone numbers
address VALUE is the list of addresses
xfields VALUE is the list of all xfields
Any other symbol is interpreted as the label for an xfield.
Then VALUE is the value of this xfield.
See also `bbdb-record-field'."
(bbdb-editable)
(if (memq field '(name-lf mail-aka mail-canon aka-all))
(error "`%s' is not allowed as the name of a field" field))
(let ((record-type (cdr bbdb-record-type)))
(cond ((eq field 'firstname) ; First name
(if merge (error "Does not merge names"))
(if check (bbdb-check-type value (bbdb-record-firstname record-type) t))
(bbdb-check-name value (bbdb-record-lastname record) record)
(bbdb-record-set-name record value t))
;; Last name
((eq field 'lastname)
(if merge (error "Does not merge names"))
(if check (bbdb-check-type value (bbdb-record-lastname record-type) t))
(bbdb-check-name (bbdb-record-firstname record) value record)
(bbdb-record-set-name record t value))
;; Name
((eq field 'name)
(if merge (error "Does not merge names"))
(if (stringp value)
(setq value (bbdb-divide-name value))
(if check (bbdb-check-type value '(cons string string) t)))
(let ((fn (car value)) (ln (cdr value)))
(bbdb-check-name fn ln record)
(bbdb-record-set-name record fn ln)))
;; Affix
((eq field 'affix)
(if merge (setq value (bbdb-merge-lists (bbdb-record-affix record)
value 'bbdb-string=)))
(if check (bbdb-check-type value (bbdb-record-affix record-type) t))
(setq value (bbdb-list-strings value))
(bbdb-record-set-affix record value))
;; Organization
((eq field 'organization)
(if merge (setq value (bbdb-merge-lists (bbdb-record-organization record)
value 'bbdb-string=)))
(if check (bbdb-check-type value (bbdb-record-organization record-type) t))
(setq value (bbdb-list-strings value))
(bbdb-hash-update record (bbdb-record-organization record) value)
(dolist (organization value)
(add-to-list 'bbdb-organization-list organization))
(bbdb-record-set-organization record value))
;; AKA
((eq field 'aka)
(if merge (setq value (bbdb-merge-lists (bbdb-record-aka record)
value 'bbdb-string=)))
(if check (bbdb-check-type value (bbdb-record-aka record-type) t))
(setq value (bbdb-list-strings value))
(unless bbdb-allow-duplicates
(dolist (aka value)
(let ((old (remq record (bbdb-gethash aka '(fl-name lf-name aka)))))
(if old (error "Alternate name address \"%s\" is used by \"%s\""
aka (mapconcat 'bbdb-record-name old ", "))))))
(bbdb-hash-update record (bbdb-record-aka record) value)
(bbdb-record-set-aka record value))
;; Mail
((eq field 'mail)
(if merge (setq value (bbdb-merge-lists (bbdb-record-mail record)
value 'bbdb-string=)))
(if check (bbdb-check-type value (bbdb-record-mail record-type) t))
(setq value (bbdb-list-strings value))
(unless bbdb-allow-duplicates
(dolist (mail value)
(let ((old (remq record (bbdb-gethash mail '(mail)))))
(if old (error "Mail address \"%s\" is used by \"%s\""
mail (mapconcat 'bbdb-record-name old ", "))))))
(dolist (aka (bbdb-record-mail-aka record))
(bbdb-remhash aka record))
(dolist (mail (bbdb-record-mail-canon record))
(bbdb-remhash mail record))
(bbdb-record-set-mail record value)
(bbdb-puthash-mail record))
;; Phone
((eq field 'phone)
(if merge (setq value (bbdb-merge-lists (bbdb-record-phone record)
value 'equal)))
(if check (bbdb-check-type value (bbdb-record-phone record-type) t))
(dolist (phone value)
(add-to-list 'bbdb-phone-label-list (bbdb-phone-label phone)))
(bbdb-record-set-phone record value))
;; Address
((eq field 'address)
(if merge (setq value (bbdb-merge-lists (bbdb-record-address record)
value 'equal)))
(if check (bbdb-check-type value (bbdb-record-address record-type) t))
(dolist (address value)
(add-to-list 'bbdb-address-label-list (bbdb-address-label address))
(mapc (lambda (street) (bbdb-add-to-list 'bbdb-street-list street))
(bbdb-address-streets address))
(bbdb-add-to-list 'bbdb-city-list (bbdb-address-city address))
(bbdb-add-to-list 'bbdb-state-list (bbdb-address-state address))
(bbdb-add-to-list 'bbdb-postcode-list (bbdb-address-postcode address))
(bbdb-add-to-list 'bbdb-country-list (bbdb-address-country address)))
(bbdb-record-set-address record value))
;; all xfields
((eq field 'xfields)
(let (xfield new-xfields)
(if merge
(dolist (ov (bbdb-record-xfields record))
(if (setq xfield (assq (car ov) value))
(setcdr xfield (bbdb-merge-xfield (car ov) (cdr xfield) (cdr ov)))
(setq value (append value (list ov))))))
(if check (bbdb-check-type new-xfields (bbdb-record-xfields record-type) t))
(dolist (xfield (nreverse value))
;; Ignore junk
(when (and (cdr xfield) (not (equal "" (cdr xfield))))
(push xfield new-xfields)
(add-to-list 'bbdb-xfield-label-list (car xfield) nil 'eq)))
(bbdb-record-set-xfields record new-xfields)))
;; Single xfield
((symbolp field)
(if merge
(setq value (bbdb-merge-xfield field (bbdb-record-xfield record field)
value)))
;; The following test always succeeds
;; (if check (bbdb-check-type value 'sexp t))
;; This removes xfield FIELD if its value is nil.
(bbdb-record-set-xfield record field value))
(t (error "Unknown field type `%s'" field)))))
;; Currently unused (but possible entry for `bbdb-merge-xfield-function-alist')
(defun bbdb-merge-concat (string1 string2 &optional separator)
"Return the concatenation of STRING1 and STRING2.
SEPARATOR defaults to \"\\n\"."
(concat string1 (or separator "\n") string2))
;; Currently unused (but possible entry for `bbdb-merge-xfield-function-alist')
(defun bbdb-merge-concat-remove-duplicates (string1 string2)
"Concatenate STRING1 and STRING2, but remove duplicate lines."
(let ((lines (split-string string1 "\n")))
(dolist (line (split-string string2 "\n"))
(add-to-list 'lines line))
(bbdb-concat "\n" lines)))
(defun bbdb-merge-string-least (string1 string2)
"Return the string out of STRING1 and STRING2 that is `string-lessp'."
(if (string-lessp string1 string2)
string1
string2))
(defun bbdb-merge-string-most (string1 string2)
"Return the string out of STRING1 and STRING2 that is not `string-lessp'."
(if (string-lessp string1 string2)
string2
string1))
(defun bbdb-merge-lists (l1 l2 cmp)
"Merge two lists L1 and L2 based on comparison CMP.
An element from L2 is added to L1 if CMP returns nil for all elements of L1.
If L1 or L2 are not lists, they are replaced by (list L1) and (list L2)."
(let (merge)
(unless (listp l1) (setq l1 (list l1)))
(dolist (e2 (if (listp l2) l2 (list l2)))
(let ((ll1 l1) e1 fail)
(while (setq e1 (pop ll1))
(if (funcall cmp e1 e2)
(setq ll1 nil
fail t)))
(unless fail (push e2 merge))))
(append l1 (nreverse merge))))
(defun bbdb-merge-xfield (label value1 value2)
"For LABEL merge VALUE1 with VALUE2.
If LABEL has an entry in `bbdb-merge-xfield-function-alist', use it.
If VALUE1 or VALUE2 is a substring of the other, return the longer one.
Otherwise use `bbdb-concat'. Return nil if we have nothing to merge."
(if (stringp value1) (setq value1 (bbdb-string-trim value1 t)))
(if (stringp value2) (setq value2 (bbdb-string-trim value2 t)))
(cond ((and value1 value2)
(let ((fun (cdr (assq label bbdb-merge-xfield-function-alist))))
(cond (fun (funcall fun value1 value2))
((not (and (stringp value1) (stringp value2)))
(cons value1 value2)) ; concatenate lists
((string-match (regexp-quote value1) value2) value2)
((string-match (regexp-quote value2) value1) value1)
(t (bbdb-concat label value1 value2)))))
(value1)
(value2)))
;;; Parsing other things
(defun bbdb-divide-name (string)
"Divide STRING into a first name and a last name.
Case is ignored. Return name as (FIRST . LAST).
LAST is always a string (possibly empty). FIRST may be nil."
(let ((case-fold-search t)
first suffix)
;; Separate a suffix.
(if (string-match bbdb-lastname-suffix-re string)
(setq suffix (concat " " (match-string 1 string))
string (substring string 0 (match-beginning 0))))
(cond ((string-match "\\`\\(.+\\),[ \t\n]*\\(.+\\)\\'" string)
;; If STRING contains a comma, this probably means that STRING
;; is of the form "Last, First".
(setq first (match-string 2 string)
string (match-string 1 string)))
((string-match bbdb-lastname-re string)
(setq first (and (not (zerop (match-beginning 0)))
(substring string 0 (match-beginning 0)))
string (match-string 1 string))))
(cons (and first (bbdb-string-trim first))
(bbdb-string-trim (concat string suffix)))))
(defun bbdb-parse-postcode (string)
"Check whether STRING is a legal postcode.
Do this only if `bbdb-check-postcode' is non-nil."
(if bbdb-check-postcode
(let ((postcodes bbdb-legal-postcodes) re done)
(while (setq re (pop postcodes))
(if (string-match re string)
(setq done t postcodes nil)))
(if done string
(error "not a valid postcode.")))
string))
(defun bbdb-phone-string (phone)
"Massage string PHONE into a standard format."
;; Phone numbers should come in two forms:
(if (= 2 (length phone))
;; (1) ["where" "the number"]
(if (stringp (aref phone 1))
(aref phone 1)
(error "Not a valid phone number: %s" (aref phone 1)))
;; (2) ["where" 415 555 1212 99]
(unless (and (integerp (aref phone 2))
(integerp (aref phone 3)))
(error "Not an NANP number: %s %s" (aref phone 2) (aref phone 3)))
(concat (if (/= 0 (bbdb-phone-area phone))
(format "(%03d) " (bbdb-phone-area phone))
"")
(if (/= 0 (bbdb-phone-exchange phone))
(format "%03d-%04d"
(bbdb-phone-exchange phone) (bbdb-phone-suffix phone))
"")
(if (and (bbdb-phone-extension phone)
(/= 0 (bbdb-phone-extension phone)))
(format " x%d" (bbdb-phone-extension phone))
""))))
(defsubst bbdb-record-lessp (record1 record2)
(string< (bbdb-record-sortkey record1)
(bbdb-record-sortkey record2)))
(defmacro bbdb-error-retry (&rest body)
"Repeatedly execute BODY ignoring errors till no error occurs."
`(catch '--bbdb-error-retry--
(while t
(condition-case --c--
(throw '--bbdb-error-retry-- (progn ,@body))
(error (ding)
(message "Error: %s" (nth 1 --c--))
(sit-for 2))))))
;;; Reading and Writing the BBDB
(defun bbdb-buffer ()
"Return buffer that visits the BBDB file `bbdb-file'.
Ensure that this buffer is in sync with `bbdb-file'.
Revert the buffer if necessary.
If `bbdb-file-remote' is non-nil and it is newer than `bbdb-file',
copy it to `bbdb-file'."
(unless (buffer-live-p bbdb-buffer)
(if (and bbdb-file-remote
(file-newer-than-file-p bbdb-file-remote bbdb-file))
(copy-file bbdb-file-remote bbdb-file t t))
(with-current-buffer (setq bbdb-buffer (find-file-noselect bbdb-file))
;; Check whether auto-save file is newer than `bbdb-file'
;; Do this only when reading `bbdb-file'.
(let ((auto-save-file (make-auto-save-file-name)))
(when (and bbdb-check-auto-save-file
(file-newer-than-file-p auto-save-file buffer-file-name))
(recover-file buffer-file-name) ; this queries
(bury-buffer) ; `recover-file' selects `bbdb-buffer'
(auto-save-mode 1) ; turn auto-save back on
;; Delete auto-save file even if the user rejected to recover it,
;; so we do not keep asking.
(condition-case nil
(delete-file auto-save-file)
(file-error nil))))))
;; Make sure `bbdb-buffer' is not out of sync with disk.
(with-current-buffer bbdb-buffer
(cond ((verify-visited-file-modtime bbdb-buffer)) ; arg for Emacs 23
((bbdb-revert-buffer))
;; This is the case where `bbdb-file' has changed; the buffer
;; has changed as well; and the user has answered "no" to the
;; "flush your changes and revert" question. The only other
;; alternative is to save the file right now. If they answer
;; no to the following question, they will be asked the
;; preceeding question again and again some large (but finite)
;; number of times. `bbdb-buffer' is called a lot, you see...
((buffer-modified-p)
;; this queries
(bbdb-save t t))
(t ; Buffer and file are inconsistent, but we let them stay that way
(message "Continuing with inconsistent BBDB buffers")))
;; `bbdb-revert-buffer' kills all local variables.
(unless (assq 'bbdb-records (buffer-local-variables))
;; We are reading / reverting `bbdb-buffer'.
(set (make-local-variable 'revert-buffer-function)
'bbdb-revert-buffer)
(setq buffer-file-coding-system bbdb-file-coding-system
buffer-read-only bbdb-read-only
bbdb-mail-aliases-need-rebuilt 'parse
bbdb-changed-records nil)
;; `bbdb-before-save-hook' and `bbdb-after-save-hook' are user variables.
;; To avoid confusion, we hide the hook functions `bbdb-before-save'
;; and `bbdb-after-save' from the user as these are essential for BBDB.
(dolist (hook (cons 'bbdb-before-save bbdb-before-save-hook))
(add-hook 'before-save-hook hook nil t))
(dolist (hook (cons 'bbdb-after-save bbdb-after-save-hook))
(add-hook 'after-save-hook hook nil t))
(fillarray bbdb-hashtable 0)
(if (/= (point-min) (point-max))
(bbdb-parse-records) ; normal case: nonempty db
;; Empty db: the following does not require `insert-before-markers'
;; because there are no db-markers in this buffer.
(insert (format (concat ";; -*- mode: Emacs-Lisp; coding: %s; -*-"
"\n;;; file-format: %d\n")
bbdb-file-coding-system bbdb-file-format))
;; We pretend that `bbdb-buffer' is still unmodified,
;; so that we will (auto-)save it only if we also add records to it.
(set-buffer-modified-p nil)
(setq bbdb-end-marker (point-marker)
;; Setting `bbdb-records' makes it buffer-local,
;; so that we can use it as a test whether we have
;; initialized BBDB.
bbdb-records nil))
(run-hooks 'bbdb-after-read-db-hook)))
;; return `bbdb-buffer'
bbdb-buffer)
(defmacro bbdb-with-db-buffer (&rest body)
"Execute the forms in BODY with `bbdb-buffer' temporarily current.
If `bbdb-debug' was non-nil at compile-time, and `bbdb-buffer' is visible
in a window, temporarilly switch to that window. So when we come out,
that window has been scrolled to the record we have just modified."
(declare (indent 0))
(if bbdb-debug
`(let* ((buffer (bbdb-buffer))
(window (get-buffer-window buffer)))
(if window
(with-selected-window window
,@body)
(with-current-buffer buffer
,@body)))
`(with-current-buffer (bbdb-buffer)
,@body)))
(defun bbdb-editable ()
"Ensure that BBDB is editable, otherwise throw an error.
If BBDB is out of sync try to revert.
BBDB is not editable if it is read-only."
(if bbdb-read-only (error "BBDB is read-only"))
(let ((buffer (bbdb-buffer))) ; this reverts if necessary / possible
;; Is the following possible? Superfluous tests do not hurt.
;; It is relevant only for editing commands in a BBDB buffer,
;; but not for MUA-related editing functions.
(if (and (eq major-mode 'bbdb-mode)
bbdb-records
(not (memq (caar bbdb-records)
(with-current-buffer buffer bbdb-records))))
(error "BBDB is out of sync")))
t)
;;;###autoload
(defsubst bbdb-records ()
"Return a list of all BBDB records; read in and parse the db if necessary.
This function also notices if the corresponding file on disk has been modified."
(with-current-buffer (bbdb-buffer)
bbdb-records))
(defun bbdb-revert-buffer (&optional ignore-auto noconfirm)
"The `revert-buffer-function' for `bbdb-buffer' visiting `bbdb-file'.
IGNORE-AUTO and NOCONFIRM have same meaning as in `revert-buffer'.
See also variable `bbdb-auto-revert'.
Return t if the reversion was successful (or not needed).
Return nil otherwise."
(interactive (list (not current-prefix-arg))) ; as in `revert-buffer'
(unless (buffer-live-p bbdb-buffer)
(error "No live BBDB buffer to revert"))
(with-current-buffer bbdb-buffer
(cond ((not buffer-file-number)
;; We have not yet created `bbdb-file'
(when (or noconfirm
(yes-or-no-p "Flush your changes? "))
(erase-buffer)
(kill-all-local-variables) ; clear database
(bbdb-buffer) ; re-initialize
(set-buffer-modified-p nil)
(bbdb-undisplay-records t)))
;; If nothing has changed do nothing, return t.
((and (verify-visited-file-modtime bbdb-buffer) ; arg for Emacs 23
(not (buffer-modified-p))))
((or (and (not (verify-visited-file-modtime bbdb-buffer))
;; File changed on disk
(or noconfirm
(and bbdb-auto-revert
(not (buffer-modified-p)))
(yes-or-no-p
(if (buffer-modified-p)
"BBDB changed on disk; flush your changes and revert? "
"BBDB changed on disk; revert? "))))
(and (verify-visited-file-modtime bbdb-buffer)
;; File not changed on disk, but buffer modified
(buffer-modified-p)
(or noconfirm
(yes-or-no-p "Flush your changes and revert BBDB? "))))
(unless (file-exists-p bbdb-file)
(error "BBDB: file %s no longer exists" bbdb-file))
(kill-all-local-variables) ; clear database
;; `revert-buffer-function' has the permanent-local property
;; So to avoid looping, we need to bind it to nil explicitly.
(let (revert-buffer-function)
(revert-buffer ignore-auto t))
(bbdb-buffer) ; re-initialize
(bbdb-undisplay-records t)
t)))) ; return nil if the user rejected to revert
(defun bbdb-goto-first-record ()
"Go to where first record begins, Move to end of file if no records."
(goto-char (point-min))
(if (search-forward "\n[" nil 'move)
(forward-char -1)))
(defun bbdb-parse-records ()
"Parse BBDB records and initialize various internal variables.
If `bbdb-file' uses an outdated format, it is migrated to `bbdb-file-format'."
(unless bbdb-silent (message "Parsing BBDB..."))
(save-excursion
(save-restriction
(widen)
(bbdb-goto-first-record)
;; look backwards for file-format, and convert if necessary.
(let ((file-format (save-excursion
(if (re-search-backward
"^;+[ \t]*file-\\(format\\|version\\):[ \t]*\\([0-9]+\\)[ \t]*$" nil t)
(string-to-number (match-string 2)))))
migrate records)
(unless file-format ; current file-format, but no file-format: line.
(error "BBDB corrupted: no file-format line"))
(if (> file-format bbdb-file-format)
(error "BBDB version %s understands file format %s but not %s."
bbdb-version bbdb-file-format file-format)
(setq migrate (< file-format bbdb-file-format)))
(or (eobp) (looking-at "\\[")
(error "BBDB corrupted: no following bracket"))
;; narrow the buffer to skip over the rubbish before the first record.
(narrow-to-region (point) (point-max))
(let ((modp (buffer-modified-p))
;; Make sure those parens get cleaned up.
;; This code had better stay simple!
(inhibit-quit t)
(buffer-undo-list t)
buffer-read-only)
(goto-char (point-min)) (insert "(\n")
(goto-char (point-max)) (insert "\n)")
(goto-char (point-min))
(unwind-protect
(setq records (read (current-buffer)))
(goto-char (point-min)) (delete-char 2)
(goto-char (point-max)) (delete-char -2)
(set-buffer-modified-p modp)))
(widen)
;; Migrate if `bbdb-file' is outdated.
(if migrate (setq records (bbdb-migrate records file-format)))
;; We could first set `bbdb-phone-label-list' and
;; `bbdb-address-label-list' to their customized values. Bother?
(setq bbdb-records records
bbdb-xfield-label-list nil
bbdb-organization-list nil
bbdb-street-list nil
bbdb-city-list nil
bbdb-state-list nil
bbdb-postcode-list nil
bbdb-country-list nil)
(bbdb-goto-first-record)
(dolist (record records)
;; We assume that the markers for each record need to go at each
;; newline. If this is not the case, things can go *very* wrong.
(bbdb-debug
(unless (looking-at "\\[")
(error "BBDB corrupted: junk between records at %s" (point))))
(bbdb-cache-set-marker
(bbdb-record-set-cache record (make-vector bbdb-cache-length nil))
(point-marker))
(forward-line 1)
;; Set the completion lists
(dolist (phone (bbdb-record-phone record))
(add-to-list 'bbdb-phone-label-list (bbdb-phone-label phone)))
(dolist (address (bbdb-record-address record))
(add-to-list 'bbdb-address-label-list (bbdb-address-label address))
(mapc (lambda (street) (bbdb-add-to-list 'bbdb-street-list street))
(bbdb-address-streets address))
(bbdb-add-to-list 'bbdb-city-list (bbdb-address-city address))
(bbdb-add-to-list 'bbdb-state-list (bbdb-address-state address))
(bbdb-add-to-list 'bbdb-postcode-list (bbdb-address-postcode address))
(bbdb-add-to-list 'bbdb-country-list (bbdb-address-country address)))
(dolist (xfield (bbdb-record-xfields record))
(add-to-list 'bbdb-xfield-label-list (car xfield) nil 'eq))
(dolist (organization (bbdb-record-organization record))
(add-to-list 'bbdb-organization-list organization))
(let ((name (bbdb-concat 'name-first-last
(bbdb-record-firstname record)
(bbdb-record-lastname record))))
(when (and (not bbdb-allow-duplicates)
(bbdb-gethash name '(fl-name aka)))
;; This does not check for duplicate mail fields.
;; Yet under normal circumstances, this should really
;; not be necessary each time BBDB is loaded as BBDB checks
;; whether creating a new record or modifying an existing one
;; results in duplicates.
;; Alternatively, you can use `bbdb-search-duplicates'.
(message "Duplicate BBDB record encountered: %s" name)
(sit-for 1)))
;; We hash every record even if it is a duplicate and
;; `bbdb-allow-duplicates' is nil. Otherwise, an unhashed
;; record would not be available for things like completion
;; (and we would not know which record to keeep and which one
;; to hide). We trust the user she knows what she wants
;; if she keeps duplicate records in the database though
;; `bbdb-allow-duplicates' is nil.
(bbdb-hash-record record))
;; Note that `bbdb-xfield-label-list' serves two purposes:
;; - check whether an xfield is new to BBDB
;; - list of known xfields for minibuffer completion
;; Only in the latter case, we might want to exclude
;; those xfields that are handled automatically.
;; So the following is not a satisfactory solution.
;; (dolist (label (bbdb-layout-get-option 'multi-line 'omit))
;; (setq bbdb-xfield-label-list (delq label bbdb-xfield-label-list)))
;; `bbdb-end-marker' allows to put comments at the end of `bbdb-file'
;; that are ignored.
(setq bbdb-end-marker (point-marker))
(when migrate
(dolist (record bbdb-records)
(bbdb-overwrite-record-internal record))
;; update file format
(goto-char (point-min))
(if (re-search-forward (format "^;;; file-\\(version\\|format\\): %d$"
file-format) nil t)
(replace-match (format ";;; file-format: %d" bbdb-file-format)))))))
(unless bbdb-silent (message "Parsing BBDB...done")))
(defun bbdb-before-save ()
"Run before saving `bbdb-file' as buffer-local part of `before-save-hook'."
(when (and bbdb-file-remote
(or bbdb-file-remote-save-always
(y-or-n-p (format "Save the remote BBDB file %s too? "
bbdb-file-remote))))
;; Write the current buffer `bbdb-file' into `bbdb-file-remote'.
(let ((coding-system-for-write bbdb-file-coding-system))
(write-region (point-min) (point-max) bbdb-file-remote))))
(defun bbdb-after-save ()
"Run after saving `bbdb-file' as buffer-local part of `after-save-hook'."
(setq bbdb-changed-records nil)
(dolist (buffer (buffer-list))
(with-current-buffer buffer
(if (eq major-mode 'bbdb-mode)
(set-buffer-modified-p nil)))))
(defun bbdb-change-record (record &optional need-to-sort new)
"Update the database after a change of RECORD.
Return RECORD if RECORD got changed compared with the database,
return nil otherwise.
NEED-TO-SORT is t when the name has changed.
If NEW is t treat RECORD as new. New records are hashed.
If RECORD is not new, it is redisplayed. Yet it is then the caller's
responsibility to update the hash-table for RECORD."
(if bbdb-read-only
(error "The Insidious Big Brother Database is read-only."))
;; The call of `bbdb-records' checks file synchronization.
;; If RECORD refers to an existing record that has been changed,
;; yet in the meanwhile we reverted the BBDB file, then RECORD
;; no longer refers to a record in `bbdb-records'. So we are stuck!
;; All changes will be lost.
;; FIXME: Once all records have a UUID, we can identify the corresponding
;; record on disk that got edited, so that the user can merge the edited
;; record with what is now on disk (or do whatever with these two records).
;; This implies, first of all, that *here* we make sure that UUIDs are
;; always unique inside BBDB. Should we maintain a second cache for that?
;; If a new record happens to have the same UUID as an exisiting record,
;; this should also throw an error / branch appropriately. So the arg NEW
;; will really not be needed anymore and all these things will have a natural
;; solution.
(let ((tail (memq record (bbdb-records))))
(cond (tail ; RECORD is not new
;; If the string we currently have for RECORD in `bbdb-buffer'
;; is `equal' to the string we would write to `bbdb-buffer',
;; we really did not change RECORD at all. So we don't update RECORD
;; unless `bbdb-update-unchanged-records' tells us to do so anyway.
;; Also, we only call `bbdb-change-hook' and `bbdb-after-change-hook'
;; if RECORD got changed.
(when (or bbdb-update-unchanged-records
(not (string= (bbdb-with-db-buffer
(buffer-substring-no-properties
(bbdb-record-marker record)
(1- (if (cdr tail)
(bbdb-record-marker (cadr tail))
bbdb-end-marker))))
(let ((cache (bbdb-record-cache record))
(inhibit-quit t))
(bbdb-record-set-cache record nil)
(prog1 (bbdb-with-print-loadably
(prin1-to-string record))
(bbdb-record-set-cache record cache))))))
(run-hook-with-args 'bbdb-change-hook record)
(if (not need-to-sort) ;; If we do not need to sort, overwrite RECORD.
(bbdb-overwrite-record-internal record)
;; Since we need to sort, delete then insert RECORD.
;; Do not mess with the hash table here.
;; We assume it got updated by the caller.
(bbdb-delete-record-internal record)
(bbdb-insert-record-internal record))
(add-to-list 'bbdb-changed-records record nil 'eq)
(run-hook-with-args 'bbdb-after-change-hook record)
;; If RECORD is currently displayed update display.
(bbdb-maybe-update-display record)
record))
(new ;; Record is new and not yet in database, so add it.
(run-hook-with-args 'bbdb-create-hook record)
(run-hook-with-args 'bbdb-change-hook record)
(bbdb-insert-record-internal record)
(bbdb-hash-record record)
(add-to-list 'bbdb-changed-records record nil 'eq)
(run-hook-with-args 'bbdb-after-change-hook record)
record)
(t (error "Changes are lost.")))))
(defun bbdb-delete-record-internal (record &optional completely)
"Delete RECORD in the database file.
With COMPLETELY non-nil, also undisplay RECORD and remove it
from the hash table."
(unless (bbdb-record-marker record) (error "BBDB: marker absent"))
(if completely (bbdb-maybe-update-display record t))
(bbdb-with-db-buffer
(let ((tail (memq record bbdb-records))
(inhibit-quit t))
(unless tail (error "BBDB record absent: %s" record))
(delete-region (bbdb-record-marker record)
(if (cdr tail)
(bbdb-record-marker (car (cdr tail)))
bbdb-end-marker))
(setq bbdb-records (delq record bbdb-records))
(when completely
(bbdb-remhash (bbdb-record-name record) record)
(bbdb-remhash (bbdb-record-name-lf record) record)
(dolist (organization (bbdb-record-organization record))
(bbdb-remhash organization record))
(dolist (mail (bbdb-record-mail-canon record))
(bbdb-remhash mail record))
(dolist (aka (bbdb-record-field record 'aka-all))
(bbdb-remhash aka record))))
(bbdb-record-set-sortkey record nil)))
(defun bbdb-insert-record-internal (record)
"Insert RECORD into the database file. Return RECORD.
Do not call this function directly, call instead `bbdb-change-record'
that calls the hooks, too."
(unless (bbdb-record-marker record)
(bbdb-record-set-marker record (make-marker)))
(bbdb-with-db-buffer
;; Set the sortkey to nil so that it will automatically be recalculated
;; up-to-date for sorting
(bbdb-record-set-sortkey record nil)
;; splice record into `bbdb-records'
(bbdb-debug (if (memq record bbdb-records)
(error "BBDB record not unique: - %s" record)))
(if (or (not bbdb-records) ; first record in new database
(bbdb-record-lessp record (car bbdb-records)))
(push record bbdb-records)
(let ((records bbdb-records))
(while (and (cdr records)
(bbdb-record-lessp (nth 1 records) record))
(setq records (cdr records)))
(setcdr records (cons record (cdr records)))))
(let ((next (car (cdr (memq record bbdb-records)))))
(goto-char (if next
(bbdb-record-marker next)
bbdb-end-marker)))
;; Before writing the record, remove the cache (we do not want that
;; written to the file.) After writing, put the cache back and update
;; the cache's marker.
(let ((cache (bbdb-record-cache record))
(point (point))
(inhibit-quit t))
(bbdb-debug
(if (= point (point-min))
(error "Inserting at point-min (%s)" point))
(if (and (/= point bbdb-end-marker)
(not (looking-at "^\\[")))
(error "Not inserting before a record (%s)" point)))
(bbdb-record-set-cache record nil)
(insert-before-markers
(bbdb-with-print-loadably (prin1-to-string record)) "\n")
(set-marker (bbdb-cache-marker cache) point)
(bbdb-record-set-cache record cache))
record))
(defun bbdb-overwrite-record-internal (record)
"Overwrite RECORD in the database file. Return RECORD.
Do not call this function directly, call instead `bbdb-change-record'
that calls the hooks, too."
(bbdb-with-db-buffer
(let* ((tail (memq record bbdb-records))
(_ (unless tail (error "BBDB record absent: %s" record)))
(cache (bbdb-record-cache record))
(inhibit-quit t))
(bbdb-debug
(if (<= (bbdb-cache-marker cache) (point-min))
(error "Cache marker is %s" (bbdb-cache-marker cache))))
(goto-char (bbdb-cache-marker cache))
(bbdb-debug
(if (and (/= (point) bbdb-end-marker)
(not (looking-at "\\[")))
(error "Not inserting before a record (%s)" (point))))
(bbdb-record-set-cache record nil)
(insert (bbdb-with-print-loadably (prin1-to-string record)) "\n")
(delete-region (point)
(if (cdr tail)
(bbdb-record-marker (car (cdr tail)))
bbdb-end-marker))
(bbdb-record-set-cache record cache)
(bbdb-debug
(if (<= (if (cdr tail)
(bbdb-record-marker (car (cdr tail)))
bbdb-end-marker)
(bbdb-record-marker record))
(error "Overwrite failed")))
record)))
;; Record formatting:
;; This does not insert anything into the *BBDB* buffer,
;; which is handled in a second step by the display functions.
(defun bbdb-layout-get-option (layout option)
"For LAYOUT return value of OPTION according to `bbdb-layout-alist'."
(let ((layout-spec (if (listp layout)
layout
(assq layout bbdb-layout-alist)))
option-value)
(and layout-spec
(setq option-value (assq option layout-spec))
(cdr option-value))))
(defun bbdb-address-continental-p (address)
"Return non-nil if ADDRESS is a continental address.
This is done by comparing the postcode to `bbdb-continental-postcode-regexp'.
This is a possible identifying function for
`bbdb-address-format-list' and `bbdb-print-address-format-list'."
(string-match bbdb-continental-postcode-regexp
(bbdb-address-postcode address)))
;; This function can provide some guidance for writing
;; your own address formatting function
(defun bbdb-format-address-default (address)
"Return formatted ADDRESS as a string.
This is the default format; it is used in the US, for example.
The result looks like this:
label: street
street
...
city, state postcode
country.
This function is a possible formatting function for
`bbdb-address-format-list'."
(let ((country (bbdb-address-country address))
(streets (bbdb-address-streets address)))
(concat (if streets
(concat (mapconcat 'identity streets "\n") "\n"))
(bbdb-concat ", " (bbdb-address-city address)
(bbdb-concat " " (bbdb-address-state address)
(bbdb-address-postcode address)))
(unless (or (not country) (string= "" country))
(concat "\n" country)))))
(defun bbdb-format-address (address layout)
"Format ADDRESS using LAYOUT. Return result as a string.
The formatting rules are defined in `bbdb-address-format-list'."
(let ((list bbdb-address-format-list)
(country (bbdb-address-country address))
elt string)
(while (and (not string) (setq elt (pop list)))
(let ((identifier (car elt))
(format (nth layout elt))
;; recognize case for format identifiers
case-fold-search str)
(when (or (eq t identifier) ; default
(and (functionp identifier)
(funcall identifier address))
(and country
(listp identifier)
;; ignore case for countries
(member-ignore-case country identifier)))
(cond ((functionp format)
(setq string (funcall format address)))
((stringp format)
(setq string "")
(dolist (form (split-string (substring format 1 -1)
(substring format 0 1) t))
(cond ((string-match "%s" form) ; street
(mapc (lambda (s) (setq string (concat string (format form s))))
(bbdb-address-streets address)))
((string-match "%c" form) ; city
(unless (or (not (setq str (bbdb-address-city address))) (string= "" str))
(setq string (concat string (format (replace-regexp-in-string "%c" "%s" form) str)))))
((string-match "%p" form) ; postcode
(unless (or (not (setq str (bbdb-address-postcode address))) (string= "" str))
(setq string (concat string (format (replace-regexp-in-string "%p" "%s" form) str)))))
((string-match "%S" form) ; state
(unless (or (not (setq str (bbdb-address-state address))) (string= "" str))
(setq string (concat string (format (replace-regexp-in-string "%S" "%s" form t) str)))))
((string-match "%C" form) ; country
(unless (or (not country) (string= "" country))
(setq string (concat string (format (replace-regexp-in-string "%C" "%s" form t) country)))))
(t (error "Malformed address format element %s" form)))))
(t (error "Malformed address format %s" format))))))
(unless string
(error "No match of `bbdb-address-format-list'"))
string))
;;; Record display:
;;; This inserts formatted (pieces of) records into the BBDB buffer.
(defsubst bbdb-field-property (start field)
"Set text property bbdb-field of text between START and point to FIELD."
(put-text-property start (point) 'bbdb-field field))
(defsubst bbdb-display-text (text field &optional face)
"Insert TEXT at point. Set its text property bbdb-field to FIELD.
If FACE is non-nil, also add face FACE."
(let ((start (point)))
(insert text)
(bbdb-field-property start field)
(if face (put-text-property start (point) 'face face))))
(defun bbdb-display-list (list field &optional terminator face indent)
"Insert elements of LIST at point.
For inserted text, set text property bbdb-field to FIELD.
If TERMINATOR is non-nil use it to terminate the inserted text.
If FACE is non-nil use it as FACE for inserted text.
If INDENT and `bbdb-wrap-column' are integers, insert line breaks in between
elements of LIST if otherwise inserted text exceeds `bbdb-wrap-column'."
;; `truncate-lines' is fine for one-line layout. But it is annyoing
;; for records that are displayed with multi-line layout.
;; Non-nil `word-wrap' would be much nicer. How can we switch between
;; non-nil `truncate-lines' and non-nil `word-wrap' on a per-record basis?
;; The following code is an alternative solution using `bbdb-wrap-column'.
(let* ((separator (nth 1 (or (cdr (assq field bbdb-separator-alist))
bbdb-default-separator)))
(indent-flag (and (integerp bbdb-wrap-column)
(integerp indent)))
(prefix (if indent-flag
(concat separator "\n" (make-string indent ?\s))))
elt)
(while (setq elt (pop list))
(bbdb-display-text elt (list field elt) face)
(cond ((and list indent-flag
(> (+ (current-column) (length (car list)))
bbdb-wrap-column))
(bbdb-display-text prefix (list field) face))
(list
(bbdb-display-text separator (list field) face))
(terminator
(bbdb-display-text terminator (list field) face))))))
(defun bbdb-display-name-organization (record)
"Insert name, affix, and organization of RECORD.
If RECORD has an xfield name-face, its value is used for font-locking name.
The value of name-face may be a face that is used directly.
The value may also be a key in `bbdb-name-face-alist'. Then the
corresponding cdr is used. If none of these schemes succeeds the face
`bbdb-face' is used."
;; Should this be further customizable? We could build the following
;; from a customizable list containing function calls and strings.
;; Name
(let ((name (if (eq 'last-first
(or (bbdb-record-xfield-intern record 'name-format)
bbdb-name-format))
(bbdb-record-name-lf record)
;; default: Firstname Lastname
(bbdb-record-name record)))
(name-face (bbdb-record-xfield record 'name-face)))
(if (string= "" name) (setq name "???"))
(bbdb-display-text name (list 'name name)
(if name-face
(cond ((facep name-face) name-face)
((cdr (assoc name-face bbdb-name-face-alist)))
(t 'bbdb-name))
'bbdb-name)))
;; Affix
(let ((affix (bbdb-record-affix record)))
(when affix
(insert ", ")
(bbdb-display-list affix 'affix)))
;; Organization
(let ((organization (bbdb-record-organization record)))
(when organization
(insert " - ")
(bbdb-display-list organization 'organization nil
'bbdb-organization)))
;; Image
(if (and bbdb-image (display-images-p))
(let ((image (cond ((functionp bbdb-image)
(funcall bbdb-image record))
((memq bbdb-image '(name fl-name))
(bbdb-record-name record))
((eq bbdb-image 'lf-name)
(bbdb-record-name-lf record))
(t
(bbdb-record-xfield record bbdb-image)))))
(when (and image
(setq image (locate-file image bbdb-image-path
bbdb-image-suffixes))
(setq image (create-image image)))
(insert " ")
(insert-image image)))))
(defun bbdb-display-record-one-line (record layout field-list)
"Format RECORD for the one-line FORMAT using LAYOUT.
See `bbdb-layout-alist' for more info on layouts.
FIELD-LIST is the list of actually displayed FIELDS."
;; Name, affix, and organizations
(bbdb-display-name-organization record)
(let ((name-end (or (bbdb-layout-get-option layout 'name-end)
40))
(start (line-beginning-position)))
(when (> (- (point) start -1) name-end)
(put-text-property (+ start name-end -4) (point) 'invisible t)
(insert "..."))
(indent-to name-end))
;; rest of the fields
(let (formatfun start)
(dolist (field field-list)
(cond (;; customized formatting
(setq formatfun (intern-soft (format "bbdb-display-%s-one-line" field)))
(funcall formatfun record))
;; phone
((eq field 'phone)
(let ((phones (bbdb-record-phone record)) phone)
(if phones
(while (setq phone (pop phones))
(bbdb-display-text (format "%s " (aref phone 0))
`(phone ,phone field-label)
'bbdb-field-name)
(bbdb-display-text (format "%s%s" (aref phone 1)
(if phones " " "; "))
`(phone ,phone))))))
;; address
((eq field 'address)
(dolist (address (bbdb-record-address record))
(setq start (point))
(insert (bbdb-format-address address 3))
(bbdb-field-property start `(address ,address))
(insert "; ")))
;; mail
((eq field 'mail)
(let ((mail (bbdb-record-mail record)))
(if mail
(bbdb-display-list (if (bbdb-layout-get-option layout 'primary)
(list (car mail)) mail)
'mail "; "))))
;; AKA
((eq field 'aka)
(let ((aka (bbdb-record-aka record)))
(if aka
(bbdb-display-list aka 'aka "; "))))
;; xfields
(t
(let* ((xfield (assq field (bbdb-record-xfields record)))
(value (cdr xfield)))
(if value
(bbdb-display-text
(concat (if (stringp value)
(replace-regexp-in-string
"\n" "; " value)
;; value of xfield is a sexp
(let ((print-escape-newlines t))
(prin1-to-string value)))
"; ")
`(xfields ,xfield)))))))
;; delete the trailing "; "
(if (looking-back "; ")
(backward-delete-char 2))
(insert "\n")))
(defun bbdb-display-record-multi-line (record layout field-list)
"Format RECORD for the multi-line FORMAT using LAYOUT.
See `bbdb-layout-alist' for more info on layouts.
FIELD-LIST is the list of actually displayed FIELDS."
(bbdb-display-name-organization record)
(insert "\n")
(let* ((indent (or (bbdb-layout-get-option layout 'indentation) 21))
;; The format string FMT adds three extra characters.
;; So we subtract those from the value of INDENT.
(fmt (format " %%%ds: " (- indent 3)))
start field formatfun)
(dolist (field field-list)
(setq start (point))
(cond (;; customized formatting
(setq formatfun (intern-soft (format "bbdb-display-%s-multi-line" field)))
(funcall formatfun record))
;; phone
((eq field 'phone)
(dolist (phone (bbdb-record-phone record))
(bbdb-display-text (format fmt (concat "phone ("
(bbdb-phone-label phone)
")"))
`(phone ,phone field-label)
'bbdb-field-name)
(bbdb-display-text (concat (bbdb-phone-string phone) "\n")
`(phone ,phone))))
;; address
((eq field 'address)
(dolist (address (bbdb-record-address record))
(bbdb-display-text (format fmt (concat "address ("
(bbdb-address-label address)
")"))
`(address ,address field-label)
'bbdb-field-name)
(setq start (point))
(insert (bbdb-indent-string (bbdb-format-address address 2) indent)
"\n")
(bbdb-field-property start `(address ,address))))
;; mail
((eq field 'mail)
(let ((mail (bbdb-record-mail record)))
(when mail
(bbdb-display-text (format fmt "mail") '(mail nil field-label)
'bbdb-field-name)
(bbdb-display-list (if (bbdb-layout-get-option layout 'primary)
(list (car mail)) mail)
'mail "\n" nil indent))))
;; AKA
((eq field 'aka)
(let ((aka (bbdb-record-aka record)))
(when aka
(bbdb-display-text (format fmt "AKA") '(aka nil field-label)
'bbdb-field-name)
(bbdb-display-list aka 'aka "\n"))))
;; xfields
(t
(let* ((xfield (assq field (bbdb-record-xfields record)))
(value (cdr xfield)))
(when value
(bbdb-display-text (format fmt field)
`(xfields ,xfield field-label)
'bbdb-field-name)
(setq start (point))
(insert (bbdb-indent-string
(if (stringp value)
value
;; value of xfield is a sexp
(let ((string (pp-to-string value)))
(if (string-match "[ \t\n]+\\'" string)
(substring-no-properties
string 0 (match-beginning 0))
string)))
indent) "\n")
(bbdb-field-property start `(xfields ,xfield)))))))
(insert "\n")))
(defalias 'bbdb-display-record-full-multi-line
'bbdb-display-record-multi-line)
(defalias 'bbdb-display-record-pop-up-multi-line
'bbdb-display-record-multi-line)
(defun bbdb-display-record (record layout number)
"Insert a formatted RECORD into the current buffer at point.
LAYOUT can be a symbol describing a layout in `bbdb-layout-alist'.
If it is nil, use `bbdb-layout'.
NUMBER is the number of RECORD among the displayed records.
Move point to the end of the inserted record."
(unless layout (setq layout bbdb-layout))
(unless (assq layout bbdb-layout-alist)
(error "Unknown layout `%s'" layout))
(let ((display-p (bbdb-layout-get-option layout 'display-p))
(omit-list (bbdb-layout-get-option layout 'omit)) ; omitted fields
(order-list (bbdb-layout-get-option layout 'order)); requested field order
(all-fields (append '(phone address mail aka) ; default field order
(mapcar 'car (bbdb-record-xfields record))))
(beg (point))
format-function field-list)
(when (or (not display-p)
(and display-p
(funcall display-p)))
(if (functionp omit-list)
(setq omit-list (funcall omit-list record layout)))
(if (functionp order-list)
(setq order-list (funcall order-list record layout)))
;; first omit unwanted fields
(when (and omit-list (or (not order-list) (memq t order-list)))
(if (listp omit-list)
;; show all fields except those listed here
(dolist (omit omit-list)
(setq all-fields (delq omit all-fields)))
(setq all-fields nil))) ; show nothing
;; then order them
(cond ((not order-list)
(setq field-list all-fields))
((not (memq t order-list))
(setq field-list order-list))
(t
(setq order-list (reverse order-list)
all-fields (delq nil (mapcar (lambda (f)
(unless (memq f order-list)
f))
all-fields)))
(dolist (order order-list)
(if (eq t order)
(setq field-list (append all-fields field-list))
(push order field-list)))))
;; call the actual format function
(setq format-function
(intern-soft (format "bbdb-display-record-%s" layout)))
(if (functionp format-function)
(funcall format-function record layout field-list)
(bbdb-display-record-multi-line record layout field-list))
(put-text-property beg (point) 'bbdb-record-number number))))
(defun bbdb-display-records (records &optional layout append
select horiz-p)
"Display RECORDS using LAYOUT.
If APPEND is non-nil append RECORDS to the already displayed records.
Otherwise RECORDS overwrite the displayed records.
SELECT and HORIZ-P have the same meaning as in `bbdb-pop-up-window'."
(interactive (list (bbdb-completing-read-records "Display records: ")
(bbdb-layout-prefix)))
(if (bbdb-append-display-p) (setq append t))
;; `bbdb-redisplay-records' calls `bbdb-display-records'
;; with display information already amended to RECORDS.
(unless (or (null records)
(consp (car records)))
;; add layout and a marker to the local list of records
(setq layout (or layout bbdb-layout)
records (mapcar (lambda (record)
(list record layout (make-marker)))
records)))
(let ((first-new (caar records)) ; first new record
new-name)
;; If `bbdb-multiple-buffers' is non-nil we create a new BBDB buffer
;; when not already within one. The new buffer name starts with a space,
;; i.e. it does not clutter the buffer list.
(when (and bbdb-multiple-buffers
(not (assq 'bbdb-buffer-name (buffer-local-variables))))
(setq new-name (concat " *BBDB " (if (functionp bbdb-multiple-buffers)
(funcall bbdb-multiple-buffers)
(buffer-name))
"*"))
;; `bbdb-buffer-name' becomes buffer-local in the current buffer
;; as well as in the buffer `bbdb-buffer-name'
(set (make-local-variable 'bbdb-buffer-name) new-name))
(with-current-buffer (get-buffer-create bbdb-buffer-name) ; *BBDB*
;; If we are appending RECORDS to the ones already displayed,
;; then first remove any duplicates, and then sort them.
(if append
(let ((old-rec (mapcar 'car bbdb-records)))
(dolist (record records)
(unless (memq (car record) old-rec)
(push record bbdb-records)))
(setq records
(sort bbdb-records
(lambda (x y) (bbdb-record-lessp (car x) (car y)))))))
(bbdb-mode)
;; Normally `bbdb-records' is the only BBDB-specific buffer-local variable
;; in the *BBDB* buffer. It is intentionally not permanent-local.
;; A value of nil indicates that we need to (re)process the records.
(setq bbdb-records records)
(if new-name
(set (make-local-variable 'bbdb-buffer-name) new-name))
(unless (or bbdb-silent-internal bbdb-silent)
(message "Formatting BBDB..."))
(let ((record-number 0)
buffer-read-only all-records start)
(erase-buffer)
(bbdb-debug (setq all-records (bbdb-records)))
(dolist (record records)
(bbdb-debug (unless (memq (car record) all-records)
(error "Record %s does not exist" (car record))))
(setq start (set-marker (nth 2 record) (point)))
(bbdb-display-record (nth 0 record) (nth 1 record) record-number)
(setq record-number (1+ record-number)))
(run-hooks 'bbdb-display-hook))
(unless (or bbdb-silent-internal bbdb-silent)
(message "Formatting BBDB...done."))
(set-buffer-modified-p nil)
(bbdb-pop-up-window select horiz-p)
;; Put point on first new record in *BBDB* buffer.
(when first-new
(goto-char (nth 2 (assq first-new bbdb-records)))
(set-window-start (get-buffer-window (current-buffer)) (point))))))
(defun bbdb-undisplay-records (&optional all-buffers)
"Undisplay records in *BBDB* buffer, leaving this buffer empty.
If ALL-BUFFERS is non-nil undisplay records in all BBDB buffers."
(dolist (buffer (cond (all-buffers (buffer-list))
((let ((buffer (get-buffer bbdb-buffer-name)))
(and (buffer-live-p buffer) (list buffer))))))
(with-current-buffer buffer
(when (eq major-mode 'bbdb-mode)
(let (buffer-read-only)
(erase-buffer))
(setq bbdb-records nil)
(set-buffer-modified-p nil)))))
(defun bbdb-redisplay-record (record &optional delete-p)
"Redisplay RECORD.
If DELETE-P is non-nil RECORD is removed from the BBDB buffer.
The BBDB buffer must be current when this is called."
;; For deletion in the *BBDB* buffer we use the full information
;; about the record in the database. Therefore, we need to delete
;; the record in the *BBDB* buffer before deleting the record in
;; the database.
;; FIXME: If point is initially inside RECORD, `bbdb-redisplay-record'
;; puts point at the beginning of the redisplayed RECORD.
;; Ideally, `bbdb-redisplay-record' should put the point such that it
;; matches the previous value `bbdb-ident-point'.
(let ((full-record (assq record bbdb-records)))
(if (null full-record)
(unless delete-p
(bbdb-display-records (list record) nil t)) ; new record
(let ((marker (nth 2 full-record))
(end-marker (nth 2 (car (cdr (memq full-record bbdb-records)))))
buffer-read-only record-number)
;; If point is inside record, put it at the beginning of the record.
(if (and (<= marker (point))
(< (point) (or end-marker (point-max))))
(goto-char marker))
(save-excursion
(goto-char marker)
(setq record-number (get-text-property (point) 'bbdb-record-number))
(unless delete-p
;; First insert the reformatted record, then delete the old one,
;; so that the marker of this record cannot collapse with the
;; marker of the subsequent record
(bbdb-display-record (car full-record) (nth 1 full-record)
record-number))
(delete-region (point) (or end-marker (point-max)))
;; If we deleted a record we need to update the subsequent
;; record numbers.
(when delete-p
(let* ((markers (append (mapcar (lambda (x) (nth 2 x))
(cdr (memq full-record bbdb-records)))
(list (point-max))))
(start (pop markers)))
(dolist (end markers)
(put-text-property start end
'bbdb-record-number record-number)
(setq start end
record-number (1+ record-number))))
(setq bbdb-records (delq full-record bbdb-records)))
(run-hooks 'bbdb-display-hook))))))
(defun bbdb-maybe-update-display (record &optional delete-p)
"Update display of RECORD in all BBDB buffers.
If DELETE-P is nil RECORD is removed from the BBDB buffers."
(dolist (buffer (buffer-list))
(with-current-buffer buffer
(if (and (eq major-mode 'bbdb-mode)
(memq record (mapcar 'car bbdb-records)))
(let ((window (get-buffer-window bbdb-buffer-name)))
(if window
(with-selected-window window
(bbdb-redisplay-record record delete-p))
(bbdb-redisplay-record record delete-p)))))))
;;; window configuration hackery
(defun bbdb-pop-up-window (&optional select horiz-p)
"Display *BBDB* buffer by popping up a new window.
Finds the largest window on the screen, splits it, displaying the
*BBDB* buffer in the bottom `bbdb-pop-up-window-size' lines (unless
the *BBDB* buffer is already visible, in which case do nothing.)
Select this window if SELECT is non-nil.
If `bbdb-mua-pop-up' is 'horiz, and the first window matching
the predicate HORIZ-P is wider than the car of `bbdb-horiz-pop-up-window-size'
then the window will be split horizontally rather than vertically."
(let ((buffer (get-buffer bbdb-buffer-name)))
(unless buffer
(error "No %s buffer to display" bbdb-buffer-name))
(cond ((let ((window (get-buffer-window buffer t)))
;; We already have a BBDB window so that at most we select it
(and window
(or (not select) (select-window window)))))
;; try horizontal split
((and (eq bbdb-mua-pop-up 'horiz)
horiz-p
(>= (frame-width) (car bbdb-horiz-pop-up-window-size))
(let ((window-list (window-list))
(b-width (cdr bbdb-horiz-pop-up-window-size))
(search t) s-window)
(while (and (setq s-window (pop window-list))
(setq search (not (funcall horiz-p s-window)))))
(unless (or search (<= (window-width s-window)
(car bbdb-horiz-pop-up-window-size)))
(condition-case nil ; `split-window' might fail
(let ((window (split-window
s-window
(if (integerp b-width)
(- (window-width s-window) b-width)
(round (* (- 1 b-width) (window-width s-window))))
t))) ; horizontal split
(set-window-buffer window buffer)
(cond (bbdb-dedicated-window
(set-window-dedicated-p window bbdb-dedicated-window))
((fboundp 'display-buffer-record-window) ; GNU Emacs >= 24.1
(set-window-prev-buffers window nil)
(display-buffer-record-window 'window window buffer)))
(if select (select-window window))
t)
(error nil))))))
((eq t bbdb-pop-up-window-size)
(bbdb-pop-up-window-simple buffer select))
(t ;; vertical split
(let* ((window (selected-window))
(window-height (window-height window)))
;; find the tallest window...
(mapc (lambda (w)
(let ((w-height (window-height w)))
(if (> w-height window-height)
(setq window w window-height w-height))))
(window-list))
(condition-case nil
(progn
(unless (eql bbdb-pop-up-window-size 1.0)
(setq window (split-window ; might fail
window
(if (integerp bbdb-pop-up-window-size)
(- window-height 1 ; for mode line
(max window-min-height bbdb-pop-up-window-size))
(round (* (- 1 bbdb-pop-up-window-size)
window-height))))))
(set-window-buffer window buffer) ; might fail
(cond (bbdb-dedicated-window
(set-window-dedicated-p window bbdb-dedicated-window))
((and (fboundp 'display-buffer-record-window) ; GNU Emacs >= 24.1
(not (eql bbdb-pop-up-window-size 1.0)))
(set-window-prev-buffers window nil)
(display-buffer-record-window 'window window buffer)))
(if select (select-window window)))
(error (bbdb-pop-up-window-simple buffer select))))))))
(defun bbdb-pop-up-window-simple (buffer select)
"Display BUFFER in some window, selecting it if SELECT is non-nil.
If `bbdb-dedicated-window' is non-nil, mark the window as dedicated."
(let ((window (if select
(progn (pop-to-buffer buffer)
(get-buffer-window))
(display-buffer buffer))))
(if bbdb-dedicated-window
(set-window-dedicated-p window bbdb-dedicated-window))))
;;; BBDB mode
;;;###autoload
(define-derived-mode bbdb-mode special-mode "BBDB"
"Major mode for viewing and editing the Insidious Big Brother Database.
Letters no longer insert themselves. Numbers are prefix arguments.
You can move around using the usual cursor motion commands.
\\<bbdb-mode-map>
\\[bbdb-add-mail-alias]\t Add new mail alias to visible records or \
remove it.
\\[bbdb-edit-field]\t Edit the field on the current line.
\\[bbdb-delete-field-or-record]\t Delete the field on the \
current line. If the current line is the\n\t first line of a record, then \
delete the entire record.
\\[bbdb-insert-field]\t Insert a new field into the current record. \
Note that this\n\t will let you add new fields of your own as well.
\\[bbdb-transpose-fields]\t Swap the field on the current line with the \
previous field.
\\[bbdb-dial]\t Dial the current phone field.
\\[bbdb-next-record], \\[bbdb-prev-record]\t Move to the next or the previous \
displayed record, respectively.
\\[bbdb-create]\t Create a new record.
\\[bbdb-toggle-records-layout]\t Toggle whether the current record is displayed in a \
one-line\n\t listing, or a full multi-line listing.
\\[bbdb-do-all-records]\\[bbdb-toggle-records-layout]\t Do that \
for all displayed records.
\\[bbdb-merge-records]\t Merge the contents of the current record with \
some other, and then\n\t delete the current record.
\\[bbdb-omit-record]\t Remove the current record from the display without \
deleting it from\n\t the database. This is often a useful thing to do \
before using one\n\t of the `*' commands.
\\[bbdb]\t Search for records in the database (on all fields).
\\[bbdb-search-mail]\t Search for records by mail address.
\\[bbdb-search-organization]\t Search for records by organization.
\\[bbdb-search-xfields]\t Search for records by xfields.
\\[bbdb-search-name]\t Search for records by name.
\\[bbdb-search-changed]\t Display records that have changed since the database \
was saved.
\\[bbdb-mail]\t Compose mail to the person represented by the \
current record.
\\[bbdb-do-all-records]\\[bbdb-mail]\t Compose mail \
to everyone whose record is displayed.
\\[bbdb-save]\t Save the BBDB file to disk.
\\[bbdb-print]\t Create a TeX file containing a pretty-printed version \
of all the\n\t records in the database.
\\[bbdb-do-all-records]\\[bbdb-print]\t Do that for the \
displayed records only.
\\[other-window]\t Move to another window.
\\[bbdb-info]\t Read the Info documentation for BBDB.
\\[bbdb-help]\t Display a one line command summary in the echo area.
\\[bbdb-browse-url]\t Visit Web sites listed in the `url' field(s) of the current \
record.
For address completion using the names and mail addresses in the database:
\t in Sendmail mode, type \\<mail-mode-map>\\[bbdb-complete-mail].
\t in Message mode, type \\<message-mode-map>\\[bbdb-complete-mail].
Important variables:
\t `bbdb-auto-revert'
\t `bbdb-ignore-redundant-mails'
\t `bbdb-case-fold-search'
\t `bbdb-completion-list'
\t `bbdb-default-area-code'
\t `bbdb-default-domain'
\t `bbdb-layout'
\t `bbdb-file'
\t `bbdb-phone-style'
\t `bbdb-check-auto-save-file'
\t `bbdb-pop-up-layout'
\t `bbdb-pop-up-window-size'
\t `bbdb-add-name'
\t `bbdb-add-aka'
\t `bbdb-add-mails'
\t `bbdb-new-mails-primary'
\t `bbdb-read-only'
\t `bbdb-mua-pop-up'
\t `bbdb-user-mail-address-re'
There are numerous hooks. M-x apropos ^bbdb.*hook RET
\\{bbdb-mode-map}"
(setq truncate-lines t
default-directory (file-name-directory bbdb-file)
mode-line-buffer-identification
(list 24 (buffer-name) " "
'(:eval (format "%d/%d/%d"
(1+ (or (get-text-property
(point) 'bbdb-record-number) -1))
(length bbdb-records)
;; This code gets called a lot.
;; So we keep it as simple as possible.
(with-current-buffer bbdb-buffer
(length bbdb-records))))
'(:eval (concat " "
(bbdb-concat " " (elt bbdb-modeline-info 0)
(elt bbdb-modeline-info 2)
(elt bbdb-modeline-info 4)))))
mode-line-modified
;; For the mode-line we want to be fast. So we skip the checks
;; performed by `bbdb-with-db-buffer'.
'(:eval (if (buffer-modified-p bbdb-buffer)
(if bbdb-read-only "%*" "**")
(if bbdb-read-only "%%" "--"))))
;; `bbdb-revert-buffer' acts on `bbdb-buffer'. Yet this command is usually
;; called from the *BBDB* buffer.
(set (make-local-variable 'revert-buffer-function)
'bbdb-revert-buffer)
(add-hook 'post-command-hook 'force-mode-line-update nil t))
(defun bbdb-sendmail-menu (record)
"Menu items for email addresses of RECORD."
(let ((mails (bbdb-record-mail record)))
(list
(if (cdr mails)
;; Submenu for multiple mail addresses
(cons "Send mail to..."
(mapcar (lambda (address)
(vector address `(bbdb-compose-mail
,(bbdb-dwim-mail record address))
t))
mails))
;; Single entry for single mail address
(vector (concat "Send mail to " (car mails))
`(bbdb-compose-mail ,(bbdb-dwim-mail record (car mails)))
t)))))
(defun bbdb-field-menu (record field)
"Menu items specifically for FIELD of RECORD."
(let ((type (car field)))
(append
(list
(format "Commands for %s Field:"
(cond ((eq type 'xfields)
(format "\"%s\"" (symbol-name (car (nth 1 field)))))
((eq type 'name) "Name")
((eq type 'affix) "Affix")
((eq type 'organization) "Organization")
((eq type 'aka) "Alternate Names")
((eq type 'mail) "Mail Addresses")
((memq type '(address phone))
(format "\"%s\" %s" (aref (nth 1 field) 0)
(capitalize (symbol-name type)))))))
(cond ((eq type 'phone)
(list (vector (concat "Dial " (bbdb-phone-string (nth 1 field)))
`(bbdb-dial ',field nil) t)))
((eq type 'xfields)
(let* ((field (cadr field))
(type (car field)))
(cond ((eq type 'url )
(list (vector (format "Browse \"%s\"" (cdr field))
`(bbdb-browse-url ,record) t)))))))
'(["Edit Field" bbdb-edit-field t])
(unless (eq type 'name)
'(["Delete Field" bbdb-delete-field-or-record t])))))
(defun bbdb-insert-field-menu (record)
"Submenu for inserting a new field for RECORD."
(cons "Insert New Field..."
(mapcar
(lambda (field)
(if (stringp field) field
(vector (symbol-name field)
`(bbdb-insert-field
,record ',field (bbdb-read-field ,record ',field
,current-prefix-arg))
(not (or (and (eq field 'affix) (bbdb-record-affix record))
(and (eq field 'organization)
(bbdb-record-organization record))
(and (eq field 'mail) (bbdb-record-mail record))
(and (eq field 'aka) (bbdb-record-aka record))
(assq field (bbdb-record-xfields record)))))))
(append '(affix organization aka phone address mail)
'("--") bbdb-xfield-label-list))))
(defun bbdb-mouse-menu (event)
"BBDB mouse menu for EVENT,"
(interactive "e")
(mouse-set-point event)
(let* ((record (bbdb-current-record))
(field (bbdb-current-field))
(menu (if (and record field (functionp bbdb-user-menu-commands))
(funcall bbdb-user-menu-commands record field)
bbdb-user-menu-commands)))
(if record
(popup-menu
(append
(list
(format "Commands for record \"%s\":" (bbdb-record-name record))
["Delete Record" bbdb-delete-records t]
["Toggle Record Display Layout" bbdb-toggle-records-layout t]
(if (and (not (eq 'full-multi-line
(nth 1 (assq record bbdb-records))))
(bbdb-layout-get-option 'multi-line 'omit))
["Fully Display Record" bbdb-display-records-completely t])
["Omit Record" bbdb-omit-record t]
["Merge Record" bbdb-merge-records t])
(if (bbdb-record-mail record)
(bbdb-sendmail-menu record))
(list "--" (bbdb-insert-field-menu record))
(if field
(cons "--" (bbdb-field-menu record field)))
(if menu
(append '("--" "User Defined Commands") menu)))))))
(defun bbdb-scan-property (property predicate n)
"Scan for change of PROPERTY matching PREDICATE for N times.
Return position of beginning of matching interval."
(let ((fun (if (< 0 n) 'next-single-property-change
'previous-single-property-change))
(limit (if (< 0 n) (point-max) (point-min)))
(nn (abs n))
(i 0)
(opoint (point))
npoint)
;; For backward search, move point to beginning of interval with PROPERTY.
(if (and (<= n 0)
(< (point-min) opoint)
(let ((prop (get-text-property opoint property)))
(and (eq prop (get-text-property (1- opoint) property))
(funcall predicate prop))))
(setq opoint (previous-single-property-change opoint property nil limit)))
(if (zerop n)
opoint ; Return beginning of interval point is in
(while (and (< i nn)
(let (done)
(while (and (not done)
(setq npoint (funcall fun opoint property nil limit)))
(cond ((and (/= opoint npoint)
(funcall predicate (get-text-property
npoint property)))
(setq opoint npoint done t))
((= opoint npoint)
;; Search reached beg or end of buffer: abort.
(setq done t i nn npoint nil))
(t (setq opoint npoint))))
done))
(setq i (1+ i)))
npoint)))
(defun bbdb-next-record (n)
"Move point to the beginning of the next BBDB record.
With prefix N move forward N records."
(interactive "p")
(let ((npoint (bbdb-scan-property 'bbdb-record-number 'integerp n)))
(if npoint (goto-char npoint)
(error "No %s record" (if (< 0 n) "next" "previous")))))
(defun bbdb-prev-record (n)
"Move point to the beginning of the previous BBDB record.
With prefix N move backwards N records."
(interactive "p")
(bbdb-next-record (- n)))
(defun bbdb-next-field (n)
"Move point to next (sub)field.
With prefix N move forward N (sub)fields."
(interactive "p")
(let ((npoint (bbdb-scan-property
'bbdb-field
(lambda (p) (and (nth 1 p)
(not (eq (nth 2 p) 'field-label))))
n)))
(if npoint (goto-char npoint)
(error "No %s field" (if (< 0 n) "next" "previous")))))
(defun bbdb-prev-field (n)
"Move point to previous (sub)field.
With prefix N move backwards N (sub)fields."
(interactive "p")
(bbdb-next-field (- n)))
(defun bbdb-save (&optional prompt noisy)
"Save the BBDB if it is modified.
If PROMPT is non-nil prompt before saving.
If NOISY is non-nil as in interactive calls issue status messages."
(interactive (list nil t))
(bbdb-with-db-buffer
(if (buffer-modified-p)
(if (or (not prompt)
(y-or-n-p
(if bbdb-read-only
"Save the BBDB, even though it is supposedly read-only? "
"Save the BBDB now? ")))
(save-buffer))
(if noisy (message "(No BBDB changes need to be saved)")))))
;;;###autoload
(defun bbdb-version (&optional arg)
"Return string describing the version of BBDB.
With prefix ARG, insert string at point."
(interactive (list (or (and current-prefix-arg 1) t)))
(let ((version-string (format "BBDB version %s (%s)"
bbdb-version bbdb-version-date)))
(cond ((numberp arg) (insert (message version-string)))
((eq t arg) (message version-string))
(t version-string))))
(defun bbdb-sort-records ()
"Sort BBDB database.
This is not needed when using BBDB itself. It might be necessary,
however, after having used other programs to add records to the BBDB."
(interactive)
(let* ((records (copy-sequence (bbdb-records))))
(bbdb-with-db-buffer
(setq bbdb-records (sort bbdb-records 'bbdb-record-lessp))
(if (equal records bbdb-records)
(message "BBDB need not be sorted")
(message "BBDB was mis-sorted; fixing...")
(bbdb-goto-first-record)
(delete-region (point) bbdb-end-marker)
(let ((buf (current-buffer))
(inhibit-quit t) ; really, don't mess with this
cache)
(dolist (record bbdb-records)
;; Before printing the record, remove cache (we do not want that
;; written to the file.) Ater writing, put the cache back
;; and update the cache's marker.
(setq cache (bbdb-record-cache record))
(set-marker (bbdb-cache-marker cache) (point))
(bbdb-record-set-cache record nil)
(bbdb-with-print-loadably (prin1 record buf))
(bbdb-record-set-cache record cache)
(insert ?\n)))
(message "BBDB was mis-sorted; fixing...done")))))
;;;###autoload
(defun bbdb-initialize (&rest muas)
"Initialize BBDB for MUAS and miscellaneous packages.
List MUAS may include the following symbols to initialize the respective
mail/news readers, composers, and miscellaneous packages:
gnus Gnus mail/news reader.
mh-e MH-E mail reader.
mu4e Mu4e mail reader.
rmail Rmail mail reader.
vm VM mail reader.
mail Mail (M-x mail).
message Message mode.
anniv Anniversaries in Emacs diary.
sc Supercite. However, this is not the full story.
See bbdb-sc.el for how to fully hook BBDB into Supercite.
pgp PGP support: this adds `bbdb-pgp' to `message-send-hook'
and `mail-send-hook' so that `bbdb-pgp' runs automatically
when a message is sent.
Yet see info node `(message)Signing and encryption'
why you might not want to rely for encryption on a hook
function which runs just before the message is sent,
that is, you might want to call the command `bbdb-pgp' manually,
then call `mml-preview'.
See also `bbdb-mua-auto-update-init'. The latter is a separate function
as this allows one to initialize the auto update feature for some MUAs only,
for example only for outgoing messages."
(dolist (mua muas)
(let ((init (assq mua bbdb-init-forms)))
(if init
;; Should we make sure that each insinuation happens only once?
(eval (cadr init))
(bbdb-warn "Do not know how to insinuate `%s'" mua))))
(run-hooks 'bbdb-initialize-hook))
(provide 'bbdb)
;;; bbdb.el ends here
|