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
|
;;; rt-liberation.el --- Emacs interface to RT -*- lexical-binding: t; -*-
;; Copyright (C) 2008-2020 Free Software Foundation, Inc.
;; Author: Yoni Rabkin <yrk@gnu.org>
;; Authors: Aaron S. Hawley <aaron.s.hawley@gmail.com>, John Sullivan <johnsu01@wjsullivan.net>
;; Maintainer: Yoni Rabkin <yrk@gnu.org>
;; Version: 2.01
;; Keywords: rt, tickets
;; Package-Type: multi
;; url: http://www.nongnu.org/rtliber/
;; This file is a part of rt-liberation.
;; This program 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.
;;
;; This program 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 this program; if not, write to the Free
;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
;; MA 02111-1307, USA.
;;; Installation and Use:
;;
;; Detailed instructions for installation and use can be found in the
;; rt-liberation manual, in the doc/ directory of the distribution.
;;; History:
;;
;; Started near the end of 2008.
;;; Code:
(require 'browse-url)
(require 'time-date)
(require 'cl-lib)
(require 'rt-liberation-rest)
(declare-function rt-liber-get-ancillary-text "rt-liberation-storage.el")
(declare-function rt-liber-ticket-marked-p "rt-liberation-multi.el")
(declare-function rt-liber-set-ancillary-text "rt-liberation-storage.el")
(defgroup rt-liber nil
"*rt-liberation, the Emacs interface to RT"
:prefix "rt-liber-"
:group 'rt-liber)
(defcustom rt-liber-directory "~/.emacs.d/rt-liber"
"*Directory to store persistent information."
:type 'string
:group 'rt-liber)
(defvar rt-liber-viewer-section-header-regexp
"^# [0-9]+/[0-9]+ (id/[0-9]+/total)")
(defvar rt-liber-viewer-section-field-regexp
"^\\(.+\\): \\(.+\\)$")
(defconst rt-liber-viewer-font-lock-keywords
(let ((header-regexp (regexp-opt '("id: " "Ticket: " "TimeTaken: "
"Type: " "Field: " "OldValue: "
"NewValue: " "Data: "
"Description: " "Created: "
"Creator: " "Attachments: ")
t)))
(list
(list (concat "^" header-regexp ".*$") 0
'font-lock-comment-face)))
"Expressions to font-lock for RT ticket viewer.")
(defvar rt-liber-created-string "Created"
"String representation of \"created\" query tag.")
(defvar rt-liber-resolved-string "Resolved"
"String representation of \"resolved\" query tag.")
(defvar rt-liber-base-url ""
"Base url for ticket display.")
(defvar rt-liber-lastupdated-string "LastUpdated"
"String representation of \"lastupdated\" query tag.")
(defvar rt-liber-resolved-string "Resolved"
"String representation of \"resolved\" query tag.")
(defvar rt-liber-content-string "Content LIKE"
"String representation of \"content\" query tag.")
(defvar rt-liber-subject-string "Subject LIKE"
"String representation of \"subject\" query tag.")
(defvar rt-liber-email-address-string "Requestor.EmailAddress LIKE"
"String representation of \"Requestor.EmailAddress\" query tag.")
(defvar rt-liber-content-not-string "Content NOT LIKE"
"String representation of \"content\" query tag.")
(defvar rt-liber-subject-not-string "Subject NOT LIKE"
"String representation of \"subject\" query tag.")
(defvar rt-liber-email-address-not-string "Requestor.EmailAddress NOT LIKE"
"String representation of \"Requestor.EmailAddress\" query tag.")
(defvar rt-liber-content-regexp "^Content:.*$"
"Regular expression for section headers.")
(defvar rt-liber-correspondence-regexp
"^Type: \\(EmailRecord\\|CommentEmailRecord\\|Correspond\\)"
"Regular expression for correspondence sections.")
(defvar rt-liber-username nil
"Username for assigning ownership on the RT server.")
(defvar rt-liber-browser-buffer-name "*ticket-browser*"
"Name of ticket browser buffer.")
(defvar rt-liber-browser-buffer nil
"Ticket browser buffer.")
(defvar rt-liber-browser-default-sorting-function
'rt-liber-sort-by-time-created
"Default sorting function.")
(defvar rt-liber-browser-default-filter-function
'rt-liber-default-filter-f
"Default filtering function.
This is a function which accepts the ticket alist as a single
argument and returns nil if the ticket needs to be filtered out,
dropped or ignored (however you wish to put it.), otherwise the
function returns a truth value.")
(defvar rt-liber-custom-ticket-redraw-function
'rt-liber-ticketlist-browser-redraw-f
"Default ticket redraw function.")
(defvar rt-liber-ticket-old-threshold 30
"Age in days before a ticket is considered old.")
(defvar rt-liber-jump-to-latest nil
"jump to the latest correspondence when viewing a ticket.")
(defvar rt-liber-anc-p nil
"Display ancillary data for tickets.")
(defvar rt-liber-ticket-list nil
"Ticket-list structure (becomes ticket-browser buffer local).")
(defvar rt-liber-query nil
"Query structure (becomes ticket-browser buffer local).")
(defvar rt-liber-browser-time-format-string "%b %d %Y %H:%M"
"String passed to `format-time-string' in the ticket browser.")
(defvar rt-liber-browser-priority-cutoff 0
"Tickets with a priority higher than this are high priority.")
(defface rt-liber-ticket-face
'((((class color) (background dark))
(:foreground "DarkSeaGreen"))
(((class color) (background light))
(:foreground "Blue"))
(((type tty) (class mono))
(:inverse-video t))
(t (:background "Blue")))
"Face for tickets in browser buffer.")
(defface rt-liber-priority-ticket-face
'((((class color) (background dark))
(:foreground "Orange"))
(((class color) (background light))
(:foreground "Orange"))
(((type tty) (class mono))
(:inverse-video t))
(t (:background "Black")))
"Face for high priority tickets in browser buffer.")
(defvar rt-liber-browser-do-refresh t
"When t, run `rt-liber-browser-refresh' otherwise disable it.")
(defvar rt-liber-command-dictionary
'((comment . "comment")
(edit . "edit"))
"Mapping between command symbols and command strings.
The command symbols provide the programmer with a consistent way
of referring to certain commands. The command strings are the
specific strings which would produce the desired effect in the
server.")
(defvar rt-liber-field-dictionary
'((owner . "Owner")
(queue . "Queue")
(status . "Status")
(priority . "Priority"))
"Mapping between field symbols and RT field strings.
The field symbols provide the programmer with a consistent way of
referring to RT fields.")
(defvar rt-liber-status-dictionary
'((deleted . "deleted")
(resolved . "resolved")
(open . "open")
(new . "new"))
"Mapping between status symbols and status strings.
The status symbols provide the programmer with a consistent way
of referring to certain statuses. The status strings are the
server specific strings.")
(defvar rt-liber-debug-log-enable nil
"If t then enable logging of communication to a buffer.
Careful! This might create a sizable buffer.")
(defvar rt-liber-debug-log-buffer-name "*rt-liber debug log*"
"Name of debug log buffer.")
(defvar rt-liber-ticket-local nil
"Buffer local storage for a ticket.
This variable is made buffer local for the ticket history")
(defvar rt-liber-assoc-browser nil
"Browser associated with a ticket history.
This variable is made buffer local for the ticket history")
(defcustom rt-liber-gnus-comment-address "no comment address set"
"*Email address for adding a comment."
:type 'string
:group 'rt-liber-gnus)
(defcustom rt-liber-gnus-address "no reply address set"
"*Email address for replying to requestor."
:type 'string
:group 'rt-liber-gnus)
(defvar rt-liber-display-ticket-at-point-f 'rt-liber-viewer2-display-ticket-at-point
"Function for displaying ticket at point in the browser.")
(defvar rt-liber-viewer2-section-regexp "^Ticket [0-9]+ by "
"Regular expression to match a section in the viewer.")
(defvar rt-liber-viewer2-recenter 4
"Argument passed to `recenter' in the viewer.")
;;; --------------------------------------------------------
;;; Debug log
;;; --------------------------------------------------------
(defun rt-liber-debug-log-write (str)
"Write STR to debug log."
(when (not (stringp str))
(error "must be a string"))
(with-current-buffer (get-buffer-create
rt-liber-debug-log-buffer-name)
(goto-char (point-max))
(insert str)))
;;; --------------------------------------------------------
;;; TicketSQL compiler
;;; --------------------------------------------------------
(defun rt-liber-bool-p (sym)
"Return t if SYM is a boolean operator, otherwise nil."
(member sym '(and or)))
(defun rt-liber-attrib-p (sym)
"Return t if SYM is a ticket attribute, otherwise nil."
(member sym '(id owner status subject content queue lastupdatedby
email-address)))
(defun rt-liber-time-p (sym)
"Return t if SYM is a temporal attribute, otherwise nil."
(member sym '(created lastupdated resolved)))
(defun rt-liber-negation-p (sym)
(member sym '(not)))
(defun rt-liber-reduce (op seq)
"Reduce-OP with SEQ to a string of \"s0 op s1 op s2..\"."
(if seq
(cl-reduce
#'(lambda (a b)
(format "%s %s %s" a op b))
seq)
""))
(defun rt-liber-make-interval (pred before after)
"Return a formatted TicketSQL interval.
PRED temporal attribute predicate.
BEFORE date before predicate.
AFTER date after predicate."
(when (string= before "") (setq before nil))
(when (string= after "") (setq after nil))
(concat
(if before (format "%s < '%s'" pred before) "")
(if (and before after) (format " AND ") "")
(if after (format "%s > '%s'" pred after) "")))
(defmacro rt-liber-compile-query (query &optional n)
"Compile sexp-based QUERY into TicketSQL."
(cond ((null query) `"")
((stringp query) `,query)
((rt-liber-bool-p query) `,(upcase (format "%s" query)))
;; attribute (positive)
((and (rt-liber-attrib-p query)
(not n))
`,(cond ((equal query 'content) rt-liber-content-string)
((equal query 'subject) rt-liber-subject-string)
((equal query 'email-address) rt-liber-email-address-string)
(t (capitalize (format "%s =" query)))))
;; attribute (negation)
((and (rt-liber-attrib-p query)
n)
`,(cond ((equal query 'content) rt-liber-content-not-string)
((equal query 'subject) rt-liber-subject-not-string)
((equal query 'email-address) rt-liber-email-address-not-string)
(t (capitalize (format "%s !=" query)))))
;; time
((rt-liber-time-p query)
`,(cond ((equal query 'created) rt-liber-created-string)
((equal query 'lastupdated) rt-liber-lastupdated-string)
((equal query 'resolved) rt-liber-resolved-string)))
((and (listp query)
(rt-liber-time-p (car query)))
`(rt-liber-make-interval
(rt-liber-compile-query ,(car query))
(rt-liber-compile-query ,(cadr query))
(rt-liber-compile-query ,(caddr query))))
;; function (known at compile time?)
((and query
(listp query)
(not (rt-liber-bool-p (car query)))
(not (rt-liber-negation-p (car query)))
(functionp (car query)))
`(format "%s" ,query))
;; negation attribute pairs
((and (listp query)
(rt-liber-negation-p (car query))
(rt-liber-attrib-p (caadr query)))
`(format "%s '%s'"
(rt-liber-compile-query ,(caadr query) t) ; negate
(rt-liber-compile-query ,(cadadr query))))
;; attribute pairs
((and (listp query)
(rt-liber-attrib-p (car query)))
`(format "%s '%s'"
(rt-liber-compile-query ,(car query))
(rt-liber-compile-query ,(cadr query))))
;; splice boolean operators
((and (listp query)
(rt-liber-bool-p (car query)))
`(rt-liber-reduce (rt-liber-compile-query ,(car query))
(rt-liber-compile-query ,(cdr query))))
;; compound statements
((and (listp query)
(not (cdr query)))
`(list (rt-liber-compile-query ,(car query))))
((listp query)
`(append
(list (rt-liber-compile-query ,(car query)))
(rt-liber-compile-query ,(cdr query))))
;; free variable
((and query
(symbolp query))
`(format "%s" ,query))
(t (error "cannot compile query %s" query))))
;;; --------------------------------------------------------
;;; Parse Answer
;;; --------------------------------------------------------
(defun rt-liber-parse-answer (answer-string parser-f)
"Operate on ANSWER-STRING with PARSER-F."
(with-temp-buffer
(insert answer-string)
(goto-char (point-min))
(when rt-liber-debug-log-enable
(rt-liber-debug-log-write (buffer-substring (point-min)
(point-max))))
(funcall parser-f)))
;;; --------------------------------------------------------
;;; Ticket list retriever
;;; --------------------------------------------------------
(put 'rt-liber-no-result-from-query-error
'error-conditions
'(error rt-liber-errors rt-liber-no-result-from-query-error))
(put 'rt-liber-no-result-from-query-error
'error-message
"No results from query")
(defun rt-liber-ticket-base-retriever-parser-f ()
"Parser function for ticket list."
(let (ticketbase-list ticketbase (continue t))
(while (save-excursion
(re-search-forward "^id:" (point-max) t))
(while (and continue
(re-search-forward
"^\\(\\([.{} #[:alpha:]]+\\): \\(.*\\)\\)$\\|^--$"
(point-max) t))
(if (string= (match-string-no-properties 0) "--")
(setq continue nil)
(push (cons (match-string-no-properties 2)
(match-string-no-properties 3))
ticketbase)))
(push (copy-sequence ticketbase) ticketbase-list)
(setq ticketbase nil
continue t))
ticketbase-list))
(defun rt-liber-rest-ticketsql-runner-parser-f ()
"Parser function for a textual list of tickets."
(let (idsub-list)
(rt-liber-rest-parse-http-header)
(while (re-search-forward "ticket/\\([0-9].+\\)" (point-max) t)
(push (list (match-string-no-properties 1)
".")
idsub-list))
idsub-list))
(defun rt-liber-rest-run-ls-query (query)
"Run an \"ls\" type query against the server with QUERY."
(rt-liber-parse-answer
(rt-liber-rest-query-runner "ls" query)
'rt-liber-rest-ticketsql-runner-parser-f))
(defun rt-liber-rest-run-show-base-query (idsublist)
"Run \"show\" type query against the server with IDSUBLIST."
(rt-liber-parse-answer
(rt-liber-rest-show-query-runner idsublist)
#'rt-liber-ticket-base-retriever-parser-f))
(defun rt-liber-rest-run-ticket-history-base-query (ticket-id)
"Run history query against server for TICKET-ID."
(rt-liber-parse-answer
(rt-liber-rest-query-runner "history" ticket-id)
#'(lambda ()
(rt-liber-rest-parse-http-header)
(buffer-substring (point) (point-max)))))
(defun rt-liber-rest-command-set (id field status)
"Set ticket ID status to be STATUS."
(rt-liber-parse-answer
(rt-liber-rest-edit-runner id field status)
'rt-liber-command-runner-parser-f))
;;; --------------------------------------------------------
;;; Ticket utilities
;;; --------------------------------------------------------
(defun rt-liber-ticket-days-old (ticket-alist)
"Return the age of the ticket in positive days."
(days-between (format-time-string "%Y-%m-%dT%T%z" (current-time))
(cdr (assoc "Created" ticket-alist))))
(defun rt-liber-ticket-old-p (ticket-alist)
(<= rt-liber-ticket-old-threshold
(rt-liber-ticket-days-old ticket-alist)))
(defun rt-liber-ticket-id-only (ticket-alist)
"Return numerical portion of ticket number from TICKET-ALIST."
(if ticket-alist
(substring (cdr (assoc "id" ticket-alist)) 7)
nil))
(defun rt-liber-ticket-priority-only (ticket-alist)
"Return an integer value priority or NIL."
(if ticket-alist
(let ((p-str (cdr (assoc "Priority" ticket-alist))))
(if p-str
(string-to-number p-str)
nil))
nil))
(defun rt-liber-ticket-owner-only (ticket-alist)
"Return the string value of the ticket owner."
(when (not ticket-alist)
(error "null ticket-alist"))
(cdr (assoc (rt-liber-get-field-string 'owner)
ticket-alist)))
(defun rt-liber-get-field-string (field-symbol)
(when (not field-symbol)
(error "null field symbol"))
(cdr (assoc field-symbol rt-liber-field-dictionary)))
;;; --------------------------------------------------------
;;; Ticket browser
;;; --------------------------------------------------------
;; accept a ticket-alist object and return an alist mapping ticket
;; properties to format characters for use in `rt-liber-format'.
(defun rt-liber-format-function (ticket-alist)
"Return a pairing of TICKET-ALIST values to %-sequences."
(let* ((id (rt-liber-ticket-id-only ticket-alist))
(subject (cdr (assoc "Subject" ticket-alist)))
(status (cdr (assoc "Status" ticket-alist)))
(created (format-time-string
rt-liber-browser-time-format-string
(date-to-time
(cdr (assoc "Created" ticket-alist)))))
(resolved (cdr (assoc "Resolved" ticket-alist)))
(requestors (cdr (assoc "Requestors" ticket-alist)))
(creator (cdr (assoc "Creator" ticket-alist)))
(owner (rt-liber-ticket-owner-only ticket-alist))
(queue (cdr (assoc "Queue" ticket-alist)))
(anc (if rt-liber-anc-p
(rt-liber-get-ancillary-text
(rt-liber-ticket-id-only ticket-alist))
""))
(priority (cdr (assoc "Priority" ticket-alist))))
(list (cons ?i (or id "N/A"))
(cons ?s (or subject "N/A"))
(cons ?c (or created "N/A"))
(cons ?S (or status "N/A"))
(cons ?r (or resolved "N/A"))
(cons ?R (or requestors "N/A"))
(cons ?C (or creator "N/A"))
(cons ?o (or owner "N/A"))
(cons ?q (or queue "N/A"))
(cons ?A (or anc ""))
(cons ?p (or priority "N/A")))))
(defun rt-liber-browser-assoc (char alist)
"Process the %-sequence association."
(let ((v (cdr (assoc char alist))))
(cond ((eq char ?%) "%") ;; escape sequence for %
(t (or v "")))))
(defun rt-liber-high-priority-p (ticket-alist)
"Return t if TICKET-ALIST is high priority.
The ticket's priority is compared to the variable
`rt-liber-browser-priority-cutoff'."
(let ((p (rt-liber-ticket-priority-only ticket-alist)))
(if p
(< rt-liber-browser-priority-cutoff p)
nil)))
(defun rt-liber-format (format ticket-alist)
"Substitute %-sequences in FORMAT."
(let ((alist (rt-liber-format-function ticket-alist)))
(replace-regexp-in-string
"%."
(lambda (str)
(rt-liber-browser-assoc (aref str 1) alist))
format t t)))
(defun rt-liber-ticketlist-browser-redraw-f (ticket)
"Display TICKET."
(insert (rt-liber-format "[%c %i %S]" ticket))
(add-text-properties (point-at-bol)
(point-at-eol)
'(face rt-liber-ticket-face))
(when (rt-liber-high-priority-p ticket)
(let ((p (point)))
(insert (format " HIGH PRIORITY (%d)"
(rt-liber-ticket-priority-only ticket)))
(add-text-properties p
(point-at-eol)
'(face rt-liber-priority-ticket-face))))
(newline)
(insert (rt-liber-format " [%o] %R: %s" ticket))
(let ((p (point)))
(insert (rt-liber-format " %A" ticket))
(add-text-properties p (point)
'(face font-lock-comment-face)))
(newline))
(defun rt-liber-ticketlist-browser-redraw (ticketlist &optional query)
"Display TICKETLIST. Optionally display QUERY as well."
(erase-buffer)
(when query
(insert (format "Query: %s" query))
(newline)
(insert (format "%d tickets" (length ticketlist)))
(newline))
(when ticketlist
(let ((filtered-count 0))
(newline 2)
(dolist (ticket
(funcall rt-liber-browser-default-sorting-function
ticketlist))
;; skip filtered tickets, but count how many have been skipped
(if (funcall rt-liber-browser-default-filter-function ticket)
(progn
;; assumes that rt-liber-ticketlist-browser-redraw-f leaves
;; point at the end of the ticket drawn
(let ((start (point)))
(funcall rt-liber-custom-ticket-redraw-function ticket)
(add-text-properties start
(point)
(list 'rt-ticket ticket))
(when (and (featurep 'rt-liberation-multi)
(rt-liber-ticket-marked-p ticket))
(add-text-properties start
(point)
'(face rt-liber-marked-ticket-face))))
(newline))
(setq filtered-count (1+ filtered-count))))
(when (< 0 filtered-count)
(insert (format "%d tickets not shown (filtered)" filtered-count))))))
(defun rt-liber-browser-refresh (&optional _ignore-auto noconfirm)
(interactive)
(if rt-liber-query
(when (or rt-liber-browser-do-refresh
noconfirm)
;; explicitly pass nil NEW to `rt-liber-browse-query'
(rt-liber-browse-query rt-liber-query nil))
(error "no buffer-local query")))
(defun rt-liber-browser-refresh-and-return ()
(interactive)
(let ((id (rt-liber-browser-ticket-id-at-point)))
(rt-liber-browser-refresh)
(rt-liber-browser-move-point-to-ticket id)))
;; This is just a special case of
;; `rt-liber-browser-ticket-<PROPERTY>-at-point'
(defun rt-liber-browser-ticket-id-at-point (&optional point)
"Return the ticket id for the ticket at buffer position.
If POINT is nil then called on (point)."
(when (not point)
(setq point (point)))
(let ((value (rt-liber-ticket-id-only
(get-text-property point 'rt-ticket))))
(if value
value
(error "no such ticket property at point"))))
(defun rt-liber-ticket-taken-p (ticket-alist)
"Return t if TICKET-ALIST is owned by Nobody."
(when (not ticket-alist)
(error "null argument"))
(let ((owner (rt-liber-ticket-owner-only ticket-alist)))
(if (string= owner "Nobody")
nil
t)))
(defun rt-liber-next-ticket-in-browser ()
"Move point to the next ticket."
(interactive)
(let ((next (next-single-property-change (point) 'rt-ticket)))
(when next (goto-char next))))
(defun rt-liber-previous-ticket-in-browser ()
"Move point to the previous ticket."
(interactive)
(let ((prev (previous-single-property-change (point) 'rt-ticket)))
(when prev (goto-char prev))))
(defun rt-liber-display-ticket-at-point ()
"Display the contents of the ticket at point."
(interactive)
(let ((ticket-alist (get-text-property (point) 'rt-ticket)))
(rt-liber-display-ticket-history ticket-alist (current-buffer))))
(defun rt-liber-ticket-at-point ()
"Display the contents of the ticket at point."
(interactive)
(funcall rt-liber-display-ticket-at-point-f))
(defun rt-liber-browser-search (id)
"Return point where ticket with ID is displayed or nil."
(let ((p nil))
(save-excursion
(goto-char (point-min))
(let ((point-id (rt-liber-ticket-id-only
(get-text-property (point) 'rt-ticket))))
(if
;; (predicate) looks for the exceptional situation
(and point-id (string= id point-id))
;; (consequent) we're done
(setq p (point))
;; (alternative) continue looking
(while (and (not p)
(rt-liber-next-ticket-in-browser))
(let ((point-id (rt-liber-ticket-id-only
(get-text-property (point) 'rt-ticket))))
(when (string= id point-id)
(setq p (point))))))))
p))
(defun rt-liber-browser-move-point-to-ticket (id)
"Move point to the beginning of ticket with ID."
(let ((p (rt-liber-browser-search id)))
(if p
(progn
(goto-char p)
(recenter-top-bottom))
(error "ticket #%s not found" id))))
;;; --------------------------------------------------------
;;; Ticket browser sorting
;;; --------------------------------------------------------
(defun rt-liber-lex-lessthan-p (a b field)
"Return t if A is lexicographically less than B in FIELD."
(let ((field-a (cdr (assoc field a)))
(field-b (cdr (assoc field b))))
(if (and field-a field-b)
(string-lessp field-a field-b)
(error "\"%s\" is not a valid ticket field" field))))
(defun rt-liber-time-lessthan-p (a b field)
"Return t if A is chronologically less than B in FIELD."
(let ((field-a (cdr (assoc field a)))
(field-b (cdr (assoc field b))))
(if (and field-a field-b)
(time-less-p (date-to-time field-a)
(date-to-time field-b))
(error "\"%s\" is not a valid ticket field" field))))
(defun rt-liber-sort-ticket-list (ticket-list sort-f)
"Return a copy of TICKET-LIST sorted by SORT-F."
(let ((seq (copy-sequence ticket-list)))
(sort seq sort-f)))
(defun rt-liber-sort-by-owner (ticket-list)
"Sort TICKET-LIST lexicographically by owner."
(rt-liber-sort-ticket-list
ticket-list
#'(lambda (a b)
(rt-liber-lex-lessthan-p
a b (rt-liber-get-field-string 'owner)))))
(defun rt-liber-sort-by-time-created (ticket-list)
"Sort TICKET-LIST in reverse chronological order."
(reverse
(rt-liber-sort-ticket-list
ticket-list
#'(lambda (a b)
(rt-liber-time-lessthan-p a b "Created")))))
;;; --------------------------------------------------------
;;; Ticket browser filtering
;;; --------------------------------------------------------
;; See the fine manual for example code.
(defun rt-liber-default-filter-f (_ticket)
"The default filtering function for the ticket browser
This function is really a placeholder for user custom functions,
and as such always return t."
t)
;;; --------------------------------------------------------
;;; Entry points
;;; --------------------------------------------------------
(defun rt-liber-browse-query (query &optional new)
"Run QUERY against the server and launch the browser.
NEW if non-nil create additional browser buffer. If NEW is a
string then that will be the name of the new buffer."
(interactive "Mquery: ")
(condition-case nil
(rt-liber-browser-startup
(rt-liber-rest-run-show-base-query
(rt-liber-rest-run-ls-query query))
query new)
(rt-liber-no-result-from-query-error
(rt-liber-browser-with-message "no results from query"
query new))))
(defun rt-liber-print-query (query &optional ticket-redraw-f)
"Run QUERY against the server and return a string.
The optional function TICKET-REDRAW-F will be bound to
`rt-liber-custom-ticket-redraw-function' for the duration of the
query output. Note that unlike the browser output, the string
returned as no associated text properties."
(let ((rt-liber-custom-ticket-redraw-function
(or ticket-redraw-f
rt-liber-custom-ticket-redraw-function))
(out ""))
(condition-case nil
(with-temp-buffer
(rt-liber-ticketlist-browser-redraw
(rt-liber-rest-run-show-base-query
(rt-liber-rest-run-ls-query query))
query)
(setq out (buffer-substring-no-properties 1 (- (point-max) 1))))
(rt-liber-no-result-from-query-error
(rt-liber-browser-with-message "no results from query"
query)))
out))
;;; --------------------------------------------------------
;;; Major mode definitions
;;; --------------------------------------------------------
(defun rt-liber-browser-mode-quit ()
"Bury the ticket browser."
(interactive)
(bury-buffer))
(defconst rt-liber-browser-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "q") 'rt-liber-browser-mode-quit)
(define-key map (kbd "n") 'rt-liber-next-ticket-in-browser)
(define-key map (kbd "p") 'rt-liber-previous-ticket-in-browser)
(define-key map (kbd "RET") 'rt-liber-ticket-at-point)
(define-key map (kbd "g") 'revert-buffer)
(define-key map (kbd "G") 'rt-liber-browser-refresh-and-return)
(define-key map (kbd "a") 'rt-liber-browser-assign)
(define-key map (kbd "r") 'rt-liber-browser-resolve)
(define-key map (kbd "o") 'rt-liber-browser-open)
(define-key map (kbd "N") 'rt-liber-browser-new)
(define-key map (kbd "t") 'rt-liber-browser-take-ticket-at-point)
(define-key map (kbd "A") 'rt-liber-browser-ancillary-text)
(define-key map (kbd "SPC") 'scroll-up)
(define-key map (kbd "DEL") 'scroll-down)
(define-key map (kbd "M") 'rt-liber-mark-ticket-at-point)
(define-key map (kbd "P") 'rt-liber-browser-prioritize)
map)
"Key map for ticket browser.")
(define-derived-mode rt-liber-browser-mode nil
"RT Liberation Browser"
"Major Mode for browsing RT tickets.
\\{rt-liber-browser-mode-map}"
(set (make-local-variable 'revert-buffer-function)
#'rt-liber-browser-refresh)
(set (make-local-variable 'buffer-stale-function)
(lambda (&optional _noconfirm) 'slow))
(run-hooks 'rt-liber-browser-hook))
(defun rt-liber-setup-browser-name (new)
(setq rt-liber-browser-buffer
(get-buffer-create
(if new
(generate-new-buffer-name
(if (stringp new)
new
rt-liber-browser-buffer-name))
(if (and (boundp 'rt-liber-query)
rt-liber-query)
(buffer-name)
rt-liber-browser-buffer-name)))))
(defun rt-liber-browser-with-message (message &optional query new)
"Start the RT ticket browser and display MESSAGE."
(interactive)
(rt-liber-setup-browser-name new)
;; setup stage (invisible to user)
(with-current-buffer rt-liber-browser-buffer
(let ((inhibit-read-only t))
(rt-liber-browser-mode)
(goto-char (point-min))
(rt-liber-ticketlist-browser-redraw nil query)
(newline 2)
(insert message)
(set (make-local-variable 'rt-liber-query) query)))
;; display stage (user can see updates)
(switch-to-buffer rt-liber-browser-buffer)
(setq buffer-read-only t))
(defun rt-liber-browser-startup (ticket-list &optional query new)
"Start the RT ticket browser."
(interactive)
(rt-liber-setup-browser-name new)
;; setup stage (invisible to user)
(with-current-buffer rt-liber-browser-buffer
(let ((inhibit-read-only t))
(rt-liber-ticketlist-browser-redraw ticket-list query)
(goto-char (point-min))
(rt-liber-next-ticket-in-browser)
(rt-liber-browser-mode)
;; store the ticket-list and the query which produced the buffer
;; as buffer local variables
(set (make-local-variable 'rt-liber-ticket-list) ticket-list)
(set (make-local-variable 'rt-liber-query) query)))
;; display stage (user can see updates)
(switch-to-buffer rt-liber-browser-buffer)
(setq buffer-read-only t))
(defun rt-liber-browser-ancillary-text ()
"Wrapper function around storage backend."
(interactive)
(when (not (featurep 'rt-liberation-storage))
(error "rt-liberation-storage isn't loaded"))
(let ((initial-contents ""))
(rt-liber-set-ancillary-text
(read-from-minibuffer "Text: " initial-contents))))
;;; --------------------------------------------------------
;;; Command module
;;; --------------------------------------------------------
(defun rt-liber-command-get-dictionary-value (sym dic)
"Utility function for retrieving alist values."
(let ((value (cdr (assoc sym dic))))
(if value
value
(error "%s not a key in dictionary %s" sym dic))))
(defun rt-liber-command-get-command-string (command-symbol)
"Return value associated with key COMMAND-SYMBOL."
(rt-liber-command-get-dictionary-value
command-symbol
rt-liber-command-dictionary))
(defun rt-liber-command-get-status-string (status-symbol)
"Return value associated with key STATUS-SYMBOL."
(rt-liber-command-get-dictionary-value
status-symbol
rt-liber-status-dictionary))
(defun rt-liber-command-runner-parser-f ()
"Display command return status from the server to the user."
(message (buffer-string)))
(defun rt-liber-command-set-status-deleted (id)
"Set the status of ticket ID to `deleted'."
(rt-liber-rest-command-set
id
(rt-liber-get-field-string 'status)
(rt-liber-command-get-status-string 'deleted)))
(defun rt-liber-command-set-status-new (id)
"Set the status of ticket ID to `new'."
(rt-liber-rest-command-set
id
(rt-liber-get-field-string 'status)
(rt-liber-command-get-status-string 'new)))
(defun rt-liber-command-set-status-resolved (id)
"Set the status of ticket ID to `resolved'."
(rt-liber-rest-command-set
id
(rt-liber-get-field-string 'status)
(rt-liber-command-get-status-string 'resolved)))
(defun rt-liber-command-set-status-open (id)
"Set the status of ticket ID to `open'."
(rt-liber-rest-command-set
id
(rt-liber-get-field-string 'status)
(rt-liber-command-get-status-string 'open)))
(defun rt-liber-command-set-owner (id new-owner)
"Set the owner of ticket in TICKET-ALIST to NEW-OWNER."
(rt-liber-rest-command-set
id
(rt-liber-get-field-string 'owner)
new-owner))
(defun rt-liber-browser-prioritize (n)
"Assigng current ticket priority N."
(interactive "nPriority (number): ")
(rt-liber-rest-command-set
(rt-liber-browser-ticket-id-at-point)
(rt-liber-get-field-string 'priority)
;; Work around the strangeness of RT. RT doesn't accept "0" as
;; string to set priority to 0, but does accept "00".
(if (< 0 n)
(format "%s" n)
"00"))
(rt-liber-browser-refresh-and-return))
(defun rt-liber-browser-assign (name)
"Assign current ticket to a user NAME."
(interactive "sAssign to: ")
(let ((taken-p (rt-liber-ticket-taken-p
(get-text-property (point) 'rt-ticket))))
(when (or (not taken-p)
(and taken-p
(y-or-n-p "Ticket already assigned! Are you sure?")))
(rt-liber-command-set-owner
(rt-liber-browser-ticket-id-at-point)
name)
(rt-liber-browser-refresh-and-return))))
(defun rt-liber-browser-resolve ()
"Resolve the current ticket."
(interactive)
(rt-liber-command-set-status-resolved
(rt-liber-browser-ticket-id-at-point))
(rt-liber-browser-refresh-and-return))
(defun rt-liber-browser-open ()
"Open the current ticket."
(interactive)
(rt-liber-command-set-status-open
(rt-liber-browser-ticket-id-at-point))
(rt-liber-browser-refresh-and-return))
(defun rt-liber-browser-new ()
"Change the current ticket's status to `new'."
(interactive)
(rt-liber-command-set-status-new
(rt-liber-browser-ticket-id-at-point))
(rt-liber-browser-refresh-and-return))
(defun rt-liber-browser-take-ticket-at-point ()
"Assign the ticket under point to `rt-liber-username'."
(interactive)
(when (not rt-liber-username)
(error "`rt-liber-username' is nil"))
(rt-liber-browser-assign rt-liber-username))
;;; --------------------------------------------------------
;;; Viewer
;;; --------------------------------------------------------
(defun rt-liber-display-ticket-history (ticket-alist &optional assoc-browser)
"Display history for ticket.
TICKET-ALIST alist of ticket data.
ASSOC-BROWSER if non-nil should be a ticket browser."
(let* ((ticket-id (rt-liber-ticket-id-only ticket-alist))
(contents (rt-liber-rest-run-ticket-history-base-query ticket-id))
(new-ticket-buffer (get-buffer-create
(concat "*RT Ticket #" ticket-id "*"))))
(with-current-buffer new-ticket-buffer
(let ((inhibit-read-only t))
(erase-buffer)
(insert contents)
(goto-char (point-min))
(rt-liber-viewer-mode)
(set
(make-local-variable 'rt-liber-ticket-local)
ticket-alist)
(when assoc-browser
(set
(make-local-variable 'rt-liber-assoc-browser)
assoc-browser))
(set-buffer-modified-p nil)
(setq buffer-read-only t)))
(switch-to-buffer new-ticket-buffer)))
;;; ------------------------------------------------------------------
;;; viewer mode functions
;;; ------------------------------------------------------------------
(defun rt-liber-refresh-ticket-history (&optional _ignore-auto _noconfirm)
(interactive)
(if rt-liber-ticket-local
(rt-liber-display-ticket-history rt-liber-ticket-local
rt-liber-assoc-browser)
(error "not viewing a ticket")))
(defun rt-liber-jump-to-latest-correspondence ()
"Move point to the newest correspondence section."
(interactive)
(let (latest-point)
(save-excursion
(goto-char (point-max))
(when (re-search-backward rt-liber-correspondence-regexp
(point-min) t)
(setq latest-point (point))))
(if latest-point
(progn
(goto-char latest-point)
(rt-liber-next-section-in-viewer))
(message "no correspondence found"))))
(defun rt-liber-viewer-visit-in-browser ()
"Visit this ticket in the RT Web interface."
(interactive)
(let ((id (rt-liber-ticket-id-only rt-liber-ticket-local)))
(if id
(browse-url
(concat rt-liber-base-url "Ticket/Display.html?id=" id))
(error "no ticket currently in view"))))
(defun rt-liber-viewer-mode-quit ()
"Bury the ticket viewer."
(interactive)
(bury-buffer))
(defun rt-liber-viewer-show-ticket-browser ()
"Return to the ticket browser buffer."
(interactive)
(let ((id (rt-liber-ticket-id-only rt-liber-ticket-local)))
(if id
(let ((target-buffer
(if rt-liber-assoc-browser
(buffer-name rt-liber-assoc-browser)
(buffer-name rt-liber-browser-buffer-name))))
(if target-buffer
(switch-to-buffer target-buffer)
(error "associated ticket browser buffer no longer exists"))
(rt-liber-browser-move-point-to-ticket id))
(error "no ticket currently in view"))))
(defun rt-liber-next-section-in-viewer ()
"Move point to next section."
(interactive)
(forward-line 1)
(when (not (re-search-forward rt-liber-content-regexp (point-max) t))
(message "no next section"))
(goto-char (point-at-bol)))
(defun rt-liber-previous-section-in-viewer ()
"Move point to previous section."
(interactive)
(forward-line -1)
(when (not (re-search-backward rt-liber-content-regexp (point-min) t))
(message "no previous section"))
(goto-char (point-at-bol)))
(defconst rt-liber-viewer-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "q") 'rt-liber-viewer-mode-quit)
(define-key map (kbd "n") 'rt-liber-next-section-in-viewer)
(define-key map (kbd "N") 'rt-liber-jump-to-latest-correspondence)
(define-key map (kbd "p") 'rt-liber-previous-section-in-viewer)
(define-key map (kbd "V") 'rt-liber-viewer-visit-in-browser)
(define-key map (kbd "m") 'rt-liber-viewer-answer)
(define-key map (kbd "M") 'rt-liber-viewer-answer-this)
(define-key map (kbd "t") 'rt-liber-viewer-answer-provisionally)
(define-key map (kbd "T") 'rt-liber-viewer-answer-provisionally-this)
(define-key map (kbd "F") 'rt-liber-viewer-answer-verbatim-this)
(define-key map (kbd "c") 'rt-liber-viewer-comment)
(define-key map (kbd "C") 'rt-liber-viewer-comment-this)
(define-key map (kbd "g") 'revert-buffer)
(define-key map (kbd "SPC") 'scroll-up)
(define-key map (kbd "DEL") 'scroll-down)
(define-key map (kbd "h") 'rt-liber-viewer-show-ticket-browser)
map)
"Key map for ticket viewer.")
(define-derived-mode rt-liber-viewer-mode nil
"RT Liberation Viewer"
"Major Mode for viewing RT tickets.
\\{rt-liber-viewer-mode-map}"
(set
(make-local-variable 'font-lock-defaults)
'((rt-liber-viewer-font-lock-keywords)))
(set (make-local-variable 'revert-buffer-function)
#'rt-liber-refresh-ticket-history)
(set (make-local-variable 'buffer-stale-function)
(lambda (&optional _noconfirm) 'slow))
(when rt-liber-jump-to-latest
(rt-liber-jump-to-latest-correspondence))
(run-hooks 'rt-liber-viewer-hook))
;; wrapper functions around specific functions provided by a backend
(declare-function
rt-liber-gnus-compose
"rt-liberation-gnus.el")
(declare-function
rt-liber-gnus-compose-reply-to-requestor
"rt-liberation-gnus.el")
(declare-function
rt-liber-gnus-compose-reply-to-requestor-to-this
"rt-liberation-gnus.el")
(declare-function
rt-liber-gnus-compose-reply-to-requestor-verbatim-this
"rt-liberation-gnus.el")
(declare-function
rt-liber-gnus-compose-provisional
"rt-liberation-gnus.el")
(declare-function
rt-liber-gnus-compose-provisional-to-this
"rt-liberation-gnus.el")
(declare-function
rt-liber-gnus-compose-comment
"rt-liberation-gnus.el")
(declare-function
rt-liber-gnus-compose-comment-this
"rt-liberation-gnus.el")
(defun rt-liber-viewer-answer ()
"Answer the ticket."
(interactive)
(cond ((featurep 'rt-liberation-gnus)
(rt-liber-gnus-compose-reply-to-requestor))
(t (error "no function defined"))))
(defun rt-liber-viewer-answer-this ()
"Answer the ticket using the current context."
(interactive)
(cond ((featurep 'rt-liberation-gnus)
(rt-liber-gnus-compose-reply-to-requestor-to-this))
(t (error "no function defined"))))
(defun rt-liber-viewer-answer-verbatim-this ()
"Answer the ticket using the current context verbatim."
(interactive)
(cond ((featurep 'rt-liberation-gnus)
(rt-liber-gnus-compose-reply-to-requestor-verbatim-this))
(t (error "no function defined"))))
(defun rt-liber-viewer-answer-provisionally ()
"Provisionally answer the ticket."
(interactive)
(cond ((featurep 'rt-liberation-gnus)
(rt-liber-gnus-compose-provisional))
(t (error "no function defined"))))
(defun rt-liber-viewer-answer-provisionally-this ()
"Provisionally answer the ticket using the current context."
(interactive)
(cond ((featurep 'rt-liberation-gnus)
(rt-liber-gnus-compose-provisional-to-this))
(t (error "no function defined"))))
(defun rt-liber-viewer-comment ()
"Comment on the ticket."
(interactive)
(cond ((featurep 'rt-liberation-gnus)
(rt-liber-gnus-compose-comment))
(t (error "no function defined"))))
(defun rt-liber-viewer-comment-this ()
"Comment on the ticket using the current context."
(interactive)
(cond ((featurep 'rt-liberation-gnus)
(rt-liber-gnus-compose-comment-this))
(t (error "no function defined"))))
;;; ------------------------------------------------------------------
;;; viewer2
;;; ------------------------------------------------------------------
;; Comment: The goal is to eventually break this code away to its own
;; file.
(defface rt-liber-ticket-emph-face
'((((class color) (background dark))
(:foreground "gray53"))
(((class color) (background light))
(:foreground "gray65"))
(((type tty) (class mono))
(:inverse-video t))
(t (:background "Blue")))
"Face for important text.")
(defconst rt-liber-viewer2-font-lock-keywords
`(("^$" 0 'rt-liber-ticket-subdued-face))
"Expressions to font-lock for RT ticket viewer.")
(defun rt-liber-viewer2-vernacular-plural (time)
"Add an ess as needed."
(if (= time 1)
""
"s"))
(defun rt-liber-viewer2-vernacular-date (date)
"Return a vernacular time delta."
(let* ((now (format-time-string "%Y-%m-%dT%T%z" (current-time)))
(days-ago (days-between now date)))
(cond ((= 0 days-ago)
"today")
((< 0 days-ago 7)
(format "%s day%s ago" days-ago
(rt-liber-viewer2-vernacular-plural days-ago)))
((< 7 days-ago 30)
(let ((weeks (floor (/ days-ago 7.0))))
(format "%s week%s ago"
weeks
(rt-liber-viewer2-vernacular-plural weeks))))
((< 30 days-ago 365)
(let ((months (floor (/ days-ago 30.0))))
(format "%s month%s ago"
months
(rt-liber-viewer2-vernacular-plural months))))
(t (let ((years (floor (/ days-ago 365.0))))
(format "%s year%s ago"
years
(rt-liber-viewer2-vernacular-plural years)))))))
(defun rt-liber-viewer2-mode-quit ()
"Bury the ticket viewer."
(interactive)
(bury-buffer))
(defun rt-liber-viewer-reduce (section-list f acc)
"A Not Invented Here tail-recursive reduce function."
(cond ((null (cdr section-list)) acc)
(t (rt-liber-viewer-reduce (cdr section-list)
f
(append acc (list
(funcall f
(car section-list)
(cadr section-list))))))))
;; According to:
;; "https://rt-wiki.bestpractical.com/wiki/REST#Ticket_History_Entry"
;; id: <history-id>
;; Ticket: <ticket-id>
;; TimeTaken: <...>
;; Type: <...>
;; Field: <...>
;; OldValue: <...>
;; NewValue: <...>
;; Data: <...>
;; Description: <...>
;; Content: <lin1-0>
;; <line-1>
;; ...
;; <line-n>
;; Creator: <...>
;; Created: <...>
;; Attachments: <...>
(defun rt-liber-viewer-parse-section (start end)
(goto-char start)
(when (not (re-search-forward
rt-liber-viewer-section-header-regexp
end t))
(error "invalid section"))
(forward-line 2)
(let (section-field-alist
(rt-field-list
'(id Ticket TimeTaken Type Field
OldValue NewValue Data Description
Creator Created)))
;; definitely error out if any of this doesn't work
(setq section-field-alist
(mapcar
(lambda (field-symbol)
(re-search-forward (format "^%s:" (symbol-name field-symbol)) end nil)
(cons field-symbol (buffer-substring (1+ (point)) (point-at-eol))))
rt-field-list))
;; content
(goto-char start)
(let ((content-start (re-search-forward "^Content: " end nil))
(content-end (progn
(re-search-forward "^Creator: " end nil)
(point-at-bol))))
(append section-field-alist
`(,(cons 'Content
(buffer-substring content-start
content-end)))))))
;; According to:
;; "https://rt-wiki.bestpractical.com/wiki/REST#Ticket_History" is of
;; the form: "# <n>/<n> (id/<history-id>/total)"
(defun rt-liber-viewer-parse-history (ticket-history)
"Parse the string TICKET-HISTORY."
(when (not (stringp ticket-history))
(error "invalid ticket-history"))
(with-temp-buffer
(insert ticket-history)
(goto-char (point-min))
;; find history detail sections and procude a list of section
;; (start . end) pairs
(let (section-point-list
section-list)
(while (re-search-forward rt-liber-viewer-section-header-regexp (point-max) t)
(setq section-point-list (append section-point-list
(list (point-at-bol)))))
(when (not section-point-list)
(error "no history detail sections found"))
(setq section-point-list (append section-point-list
(list (point-max)))
section-point-list (rt-liber-viewer-reduce section-point-list #'cons nil))
;; collect the sections
(setq section-list
(mapcar
(lambda (section-points)
(rt-liber-viewer-parse-section
(car section-points)
(cdr section-points)))
section-point-list))
section-list)))
(defun rt-liber-viewer2-get-section-data ()
"Return the current section data."
(let ((section (get-text-property (point) 'rt-liberation-section-data)))
(when (not section)
(save-excursion
(rt-liber-viewer2-previous-section-in)
(setq section (get-text-property (point) 'rt-liberation-section-data))))
section))
(defun rt-liber-viewer2-format-content (content)
"Wrangle RT's content format."
(with-temp-buffer
(insert content)
(goto-char (point-min))
(if (re-search-forward "^This transaction appears to have no content" (point-max) t)
"" ; make no content mean... no content
;; trim leading blank lines
(save-excursion
(goto-char (point-min))
(re-search-forward "[[:graph:]]" (point-max) t)
(forward-line -1)
(flush-lines "^[[:space:]]+$" (point-min) (point)))
;; trim trailing blank lines
(save-excursion
(goto-char (point-max))
(re-search-backward "[[:graph:]]" (point-min) t)
(forward-line 2)
(flush-lines "^[[:space:]]+$" (point-max) (point)))
;; Convert the 9 leading whitespaces from RT's comment lines.
(goto-char (point-min))
(insert " ")
(while (re-search-forward "^ " (point-max) t)
(replace-match " "))
;; fill
(let ((paragraph-separate " >[[:space:]]+$"))
(fill-region (point-min)
(point-max)))
;; finally
(buffer-substring (point-min)
(point-max)))))
(defun rt-liber-viewer2-clean-content (section)
"Format section content for email."
(with-temp-buffer
(insert (rt-liber-viewer2-format-content
(alist-get 'Content section)))
(goto-char (point-min))
(while (re-search-forward "^ " (point-max) t)
(replace-match ""))
;; fill
(let ((paragraph-separate ">[[:space:]]+$"))
(fill-region (point-min)
(point-max)))
;; finally
(buffer-substring (point-min)
(point-max))))
(defun rt-liber-viewer2-display-section (section)
(let ((start (point))
(ticket-id (alist-get 'Ticket section))
(creator (alist-get 'Creator section))
(date (alist-get 'Created section))
(type (alist-get 'Type section))
(oldvalue (alist-get 'OldValue section))
(newvalue (alist-get 'NewValue section))
(field (alist-get 'Field section))
(s-content (rt-liber-viewer2-format-content
(alist-get 'Content section))))
(when (not (or (string= type "CommentEmailRecord")
(string= type "EmailRecord")))
(insert
(format "Ticket %s by %s, %s (%s) [%s]\n"
ticket-id
creator
(rt-liber-viewer2-vernacular-date date)
date
(format "%s%s%s"
type
(if (< 0 (length oldvalue))
(concat " " oldvalue)
"")
(if (< 0 (length newvalue))
(concat "->" newvalue)
""))))
(add-text-properties start
(point)
`(font-lock-face rt-liber-ticket-emph-face))
(add-text-properties start
(point)
`(rt-liberation-viewer-header t))
(add-text-properties start
(point)
`(rt-liberation-section-data ,section))
(cond ((string= type "Status")
(insert
(format "\n Status change from %s to %s\n\n" oldvalue newvalue)))
((and (string= type "Set")
(string= field "Owner")
(string= oldvalue "10"))
(insert
(format "\n Ticket assigned\n\n")))
;; catch-all
(t
(insert
(format "\n%s\n" s-content)))))))
(defun rt-liber-viewer2-display-history (contents)
(let ((section-list (rt-liber-viewer-parse-history contents)))
(mapc
(lambda (section)
(rt-liber-viewer2-display-section section))
section-list)))
(defun rt-liber-viewer2-display-ticket-at-point ()
"Display the contents of the ticket at point."
(interactive)
(let ((ticket-alist (get-text-property (point) 'rt-ticket)))
(rt-liber-viewer2-display-ticket-history ticket-alist (current-buffer))))
(defun rt-liber-viewer2-display-ticket-history (ticket-alist &optional assoc-browser)
"Display history for ticket.
TICKET-ALIST alist of ticket data.
ASSOC-BROWSER if non-nil should be a ticket browser."
(let* ((ticket-id (rt-liber-ticket-id-only ticket-alist))
(contents (rt-liber-rest-run-ticket-history-base-query ticket-id))
(new-ticket-buffer (get-buffer-create
(concat "*RT (Viewer) Ticket #" ticket-id "*"))))
(with-current-buffer new-ticket-buffer
(let ((inhibit-read-only t))
(erase-buffer)
(rt-liber-viewer2-display-history contents)
(goto-char (point-min))
(rt-liber-viewer2-mode)
(set
(make-local-variable 'rt-liber-ticket-local)
ticket-alist)
(when assoc-browser
(set
(make-local-variable 'rt-liber-assoc-browser)
assoc-browser))
(set-buffer-modified-p nil)
(setq buffer-read-only t)))
(switch-to-buffer new-ticket-buffer)))
(defun rt-liber-viewer2-refresh-ticket-history (&optional _ignore-auto _noconfirm)
(interactive)
(if rt-liber-ticket-local
(rt-liber-viewer2-display-ticket-history rt-liber-ticket-local
rt-liber-assoc-browser)
(error "not viewing a ticket")))
(defun rt-liber-viewer2-next-section-in ()
(interactive)
(when (looking-at rt-liber-viewer2-section-regexp)
(goto-char (1+ (point))))
(let ((next (re-search-forward rt-liber-viewer2-section-regexp
(point-max)
t)))
(cond ((not next)
(message "no next section"))
(t
(recenter rt-liber-viewer2-recenter)))
(goto-char (point-at-bol))))
(defun rt-liber-viewer2-last-section-in ()
(interactive)
(goto-char (point-max))
(let ((last (re-search-backward rt-liber-viewer2-section-regexp
(point-min)
t)))
(if (not last)
(error "no sections found")
(recenter rt-liber-viewer2-recenter)
(goto-char (point-at-bol)))))
(defun rt-liber-viewer2-previous-section-in ()
(interactive)
(when (looking-at rt-liber-viewer2-section-regexp)
(goto-char (1- (point))))
(let ((prev (re-search-backward rt-liber-viewer2-section-regexp
(point-min)
t)))
(cond ((not prev)
(message "no previous section"))
(t
(recenter rt-liber-viewer2-recenter)))
(goto-char (point-at-bol))))
(defun rt-liber-viewer2-answer ()
(interactive)
(let ((section (rt-liber-viewer2-get-section-data)))
(when (not section)
(error "no section found"))
(if (not (featurep 'rt-liberation-gnus))
(error "rt-liberation-gnus feature not found")
(rt-liber-gnus-compose
rt-liber-gnus-address
rt-liber-ticket-local
`((contents . ,(rt-liber-viewer2-clean-content section)))))))
(defun rt-liber-viewer2-comment ()
(interactive)
(let ((section (rt-liber-viewer2-get-section-data)))
(when (not section)
(error "no section found"))
(if (not (featurep 'rt-liberation-gnus))
(error "rt-liberation-gnus feature not found")
(rt-liber-gnus-compose
rt-liber-gnus-comment-address
rt-liber-ticket-local
`((contents . ,(rt-liber-viewer2-clean-content section)))))))
(defconst rt-liber-viewer2-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "q") 'rt-liber-viewer2-mode-quit)
(define-key map (kbd "N") 'rt-liber-viewer2-last-section-in)
(define-key map (kbd "n") 'rt-liber-viewer2-next-section-in)
(define-key map (kbd "p") 'rt-liber-viewer2-previous-section-in)
(define-key map (kbd "V") 'rt-liber-viewer-visit-in-browser)
(define-key map (kbd "M") 'rt-liber-viewer2-answer)
(define-key map (kbd "C") 'rt-liber-viewer2-comment)
(define-key map (kbd "g") 'revert-buffer)
(define-key map (kbd "SPC") 'scroll-up)
(define-key map (kbd "DEL") 'scroll-down)
(define-key map (kbd "h") 'rt-liber-viewer-show-ticket-browser)
map)
"Key map for ticket viewer2.")
(define-derived-mode rt-liber-viewer2-mode nil
"RT Liberation Viewer"
"Major Mode for viewing RT tickets.
\\{rt-liber-viewer-mode-map}"
(set
(make-local-variable 'font-lock-defaults)
'((rt-liber-viewer2-font-lock-keywords)))
(set (make-local-variable 'revert-buffer-function)
#'rt-liber-viewer2-refresh-ticket-history)
(set (make-local-variable 'buffer-stale-function)
(lambda (&optional _noconfirm) 'slow))
(run-hooks 'rt-liber-viewer-hook))
(provide 'rt-liberation)
;;; rt-liberation.el ends here.
|