-
Notifications
You must be signed in to change notification settings - Fork 1
/
perkeep.el
662 lines (592 loc) · 22.1 KB
/
perkeep.el
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
;; -*- lexical-binding: t -*-
;;
;; emacs-perkeep is a client for the perkeep server.
;; Copyright (C) 2020 Markus Peröbner
;;
;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU Affero 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 Affero General Public License for more details.
;;
;; You should have received a copy of the GNU Affero General Public License
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
(require 'dash)
(require 'deferred)
(require 'request-deferred)
(setq perkeep--client-config-cache nil)
;; (perkeep-client-config)
(defun perkeep-client-config ()
"Returns the default perkeep client config."
(interactive)
(if perkeep--client-config-cache
perkeep--client-config-cache
(setq perkeep--client-config-cache (perkeep--fetch-client-config))))
(defun perkeep--fetch-client-config ()
(json-read-file "~/.config/perkeep/client-config.json"))
;; (perkeep--client-config-server)
(defun perkeep--client-config-server ()
"Returns the default server from the perkeep client config."
(interactive)
(let (servers default-server auth)
(setq servers (cdr (assoc-string "servers" (perkeep-client-config))))
(setq default-server (cdr (-find (lambda (s) (not (eq (cdr (assoc-string "default" s)) json-false))) servers)))
(setq auth (cdr (split-string (cdr (assoc-string "auth" default-server)) ":")))
(list
(cons "url" (cdr (assoc-string "server" default-server)))
(cons "user" (car auth))
(cons "password" (car (cdr auth))))))
(setq perkeep--default-ui-config-cache nil)
(defun perkeep--default-ui-config ()
"Returns the configuration of the server's UI handler."
(interactive)
(if perkeep--default-ui-config-cache
(deferred:$
(deferred:next
(lambda ()
perkeep--default-ui-config-cache)))
(setq
perkeep--default-ui-config-cache
(deferred:$
(perkeep--fetch-default-ui-config)
(deferred:nextc it
(lambda (ui-config)
(setq perkeep--default-ui-config-cache ui-config)
perkeep--default-ui-config-cache))))))
;; (perkeep--fetch-default-ui-config `(lambda (data) (message "hello %S" data)))
(defun perkeep--fetch-default-ui-config ()
(perkeep--request "/ui/?camli.mode=config"))
;; (perkeep-search (perkeep-query-expression "tag:solln") `(lambda (data) (switch-to-buffer (generate-new-buffer "perkeep-debug")) (insert (json-encode data)) (json-pretty-print-buffer) (javascript-mode)))
(defun perkeep-search (query)
"perkeep-search is the main entry point for performing a search
against the perkeep repository.
The function takes a query object which is the equivalent of the perkeep
query object. It must be an associate list with the properties defined
in the SearchQuery perkeep Go struct (see
perkeep.org/pkg/search/query.go within perkeep repository).
There the following builder functions to create query lists:
- `perkeep-query-expression'
"
(deferred:$
(perkeep--default-ui-config)
(deferred:nextc it
(lambda (ui-config)
(perkeep--request
(concat
(cdr (assoc-string "searchRoot" ui-config))
"camli/search/query")
:data (json-encode query))))))
;; (perkeep-query-expression "is:image")
(defun perkeep-query-expression (expression)
"Builds a perkeep query object from the given search expression. The
build query object is the input for the perkeep-search function.
Example query strings are:
is:image
tag:todo
attr:year:2020"
`(
("expression" . ,(eval expression))
("describe" .
(
("rules" .
(
(
("attrs" . ("camliContent")))))))))
(cl-defun perkeep--download (blob-ref file-name)
(deferred:$
(perkeep--default-ui-config)
(deferred:nextc it
(lambda (ui-config)
(perkeep--request
(concat
(cdr (assoc-string "downloadHelper" ui-config))
blob-ref
"/"
file-name)
:parser 'buffer-string)))))
(defun perkeep--upload-claim (form)
(deferred:$
(perkeep--default-ui-config)
(deferred:nextc it
(lambda (ui-config)
(perkeep--request
(concat
(cdr (assoc-string "blobRoot" ui-config))
"camli/upload")
:files form)))))
(defun perkeep--upload-form (form)
"Uploads the given alist form to perkeep. Invokes callback when done
with the content ref as argument."
(deferred:$
(perkeep--default-ui-config)
(deferred:nextc it
(lambda (ui-config)
(perkeep--request
(cdr (assoc-string "uploadHelper" ui-config))
:files form)))
(deferred:nextc it
(lambda (response)
(cdr (assoc-string "fileref" (elt (cdr (assoc-string "got" response)) 0)))))))
(defun perkeep--sign (claim)
(deferred:$
(perkeep--default-ui-config)
(deferred:nextc it
(lambda (ui-config)
(perkeep--request
(cdr (assoc-string "signHandler" (assoc-string "signing" ui-config)))
:data (let ((json-encoding-pretty-print t)
(json-encoding-default-indentation "\t"))
(concat
"json="
(url-hexify-string
;; stick to perkeeps unfixable weird claim json formatting
(concat
"{\"camliVersion\":1,\n"
(substring
(json-encode
(append
claim
`(("camliSigner" . ,(cdr (assoc-string "publicKeyBlobRef" (assoc-string "signing" ui-config)))))))
2
)))))
:parser 'buffer-string)))))
(cl-defun perkeep--request (path
&key
(data nil)
(files nil)
(parser 'json-read))
(let (server user password response-data)
(setq server (perkeep--client-config-server))
(setq user (cdr (assoc-string "user" server)))
(setq password (cdr (assoc-string "password" server)))
;; (setq request-log-level 'debug)
(deferred:$
(request-deferred
(concat
(cdr (assoc-string "url" server))
path)
:data data
:files files
:headers `(("Authorization" . ,(concat "Basic " (base64-encode-string (concat user ":" password)))))
:parser parser
;; :sync "t"
)
(deferred:nextc it
(lambda (response)
(request-response-data response))))))
;;;###autoload
(defun perkeep-find-permanode (expression)
"Performs a perkeep search for a given expression and shows the
found permanodes in a newly created buffer."
(interactive "sExpression: ")
(switch-to-buffer (generate-new-buffer expression))
(insert expression "\n")
(perkeep-mode)
(perkeep-find-permanode-from-buffer))
(defun perkeep-find-permanode-from-buffer ()
"Performs a perkeep search with an expression from the first
line of the current buffer. The results will replace the content
in the buffer after the expression."
(interactive)
(let ((expression (buffer-substring
(point-min)
(progn
(goto-char (point-min))
(end-of-line)
(point))))
(search-buffer (current-buffer)))
(goto-char (point-min))
(forward-line (1- 2))
(read-only-mode 0)
(delete-region (point) (point-max))
(read-only-mode 1)
(deferred:$
(perkeep-search
(perkeep-query-expression expression))
(deferred:nextc it
(lambda (response)
(with-current-buffer search-buffer
(goto-line 3)
(read-only-mode 0)
(insert "\n")
(perkeep--insert-search-results response)
(goto-line 3)
(read-only-mode 1)
))))))
(defun perkeep--insert-search-results (results)
(mapc
(lambda (blob-obj)
(perkeep--insert-found-permanode (cdr (assoc-string "blob" blob-obj)) results))
(cdr (assoc-string "blobs" results))))
(defun perkeep--insert-found-permanode (blob-ref results)
(insert blob-ref "\n")
(let ((description (perkeep--find-description-by-ref blob-ref results)))
(setq description (cdr (assoc-string blob-ref (assoc-string "meta" (assoc-string "description" results)))))
(when
(not (string= "permanode" (cdr (assoc-string "camliType" description))))
(error
"Expected permanode response from server but got %S"
(cdr (assoc-string "camliType" description))))
(mapc
(lambda (attrs)
(let ((key (car attrs)))
(insert (format-message "\t%s\n" key))
(mapc
(lambda (value)
(perkeep--insert-permanode-attribute-value 2 key value results))
(cdr attrs))
))
(cdr (assoc-string "attr" (assoc-string "permanode" description))))
))
(defun perkeep--insert-permanode-attribute-value (level key value results)
(perkeep--insert-permanode-value level value)
(cond
((string= key "camliContent")
(let ((file-description (perkeep--find-description-by-ref value results)))
(perkeep--insert-permanode-value (1+ level) "file")
(mapc
(lambda (key)
(let ((file-value (cdr (assoc-string key (assoc-string "file" file-description)))))
(when file-value
(perkeep--insert-permanode-value (+ level 2) key)
(perkeep--insert-permanode-value (+ level 3) file-value))))
'("fileName" "size" "mimeType"))))))
(defun perkeep--find-description-by-ref (blob-ref results)
(cdr (assoc-string blob-ref (assoc-string "meta" (assoc-string "description" results)))))
(defun perkeep--insert-permanode-value (level value)
(insert (make-string level ?\t))
(insert
(cond
((numberp value) (format-message "%s" value))
(t value))
"\n"))
(defun perkeep-follow-permanode ()
"Visit the permanode named on this line.
This will open the permanode's content in a new buffer if it has a
camliContent attribute. Otherwise it will open a new search buffer which
shows the members of this permanode."
(interactive)
(let (permanode-ref camli-content)
(setq permanode-ref (perkeep--get-permanode-ref))
(setq camli-content (car (perkeep--get-permanode-attr '("camliContent"))))
(if camli-content
(perkeep--follow-permanode-camli-content
permanode-ref
(car (perkeep--get-permanode-attr '("title")))
(car (perkeep--get-permanode-attr (list "camliContent" camli-content "file" "fileName")))
camli-content)
(error "TODO implement visiting permanode members"))))
(defun perkeep--follow-permanode-camli-content (permanode-ref title file-name camli-content)
(deferred:$
(perkeep--download
camli-content
"blob")
(deferred:nextc it
(lambda (blob)
(let (blob-buffer)
(setq blob-buffer (generate-new-buffer (or title file-name)))
(switch-to-buffer blob-buffer)
(insert blob)
(set-buffer-modified-p nil)
(goto-char (point-min))
(setq-local buffer-file-name file-name)
(normal-mode)
(setq-local perkeep-permanode-ref permanode-ref)
(perkeep-sourced-mode))))))
(defun perkeep-previous-permanode ()
(interactive)
(perkeep--move-to-permanode)
(unless (bobp)
(forward-line -1))
(perkeep--move-to-permanode))
(defun perkeep-next-permanode ()
(interactive)
(beginning-of-line)
(unless (eobp)
(forward-line 1))
(perkeep--collect-level-values 1)
(recenter))
(defun perkeep--move-to-permanode ()
"Moves point to the beginning of the current permanode"
(beginning-of-line)
(while
(and
(not (bobp))
(string= "\t" (substring (thing-at-point 'whitespace) 0 1)))
(forward-line -1))
)
(defun perkeep--get-permanode-ref ()
"Returns the permanode ref of the permanode below point."
(save-excursion
(perkeep--move-to-permanode)
(substring (thing-at-point 'line) 0 -1)))
;; TODO rename function. maybe it makes sense to call the perkeep permanode attr property attr and the buffer's permanode values (which are a combinaion of permanote attr and file properties) attributes? there are some more functions which would benefit from a clear definiton of the names.
(defun perkeep--get-permanode-attr (key-chain)
"Returns the attribute values with a given key of the permanode below
point."
(save-excursion
(perkeep--move-to-permanode)
(forward-line 1)
(let ((level 1))
(mapc
(lambda (key)
(when
(perkeep--find-permanode-attribute level key))
(setq level (1+ level)))
key-chain)
(perkeep--collect-level-values level))))
(defun perkeep--find-permanode-attribute (level key)
(let ((level-prefix (make-string level ?\t))
current-key
result)
(while
(and
(not result)
(not (eobp))
(string= level-prefix (thing-at-point 'whitespace)))
(setq current-key (substring (thing-at-point 'line) level -1))
(forward-line 1)
(if (string= current-key key)
(setq result t)
(perkeep--collect-level-values (1+ level))))
result))
(defun perkeep--collect-level-values (level)
"Collects values for a given level at point and walks over them."
(let ((level-prefix (make-string level ?\t))
current-key
(values ()))
(while
(and
(not (eobp))
(string= level-prefix (substring (thing-at-point 'whitespace) 0 (min level (length (thing-at-point 'whitespace))))))
(when (string= level-prefix (thing-at-point 'whitespace))
(setq values (append values (list (substring (thing-at-point 'line) level -1)))))
(forward-line 1))
values))
(defvar perkeep-mode-map
(let ((map (make-keymap)))
(set-keymap-parent map special-mode-map)
(define-key map "C" 'kill-current-buffer)
(define-key map "f" 'perkeep-follow-permanode)
(define-key map "\C-m" 'perkeep-follow-permanode)
(define-key map "p" 'perkeep-previous-permanode)
(define-key map " " 'perkeep-next-permanode)
(define-key map "n" 'perkeep-next-permanode)
(define-key map "r" 'isearch-backward)
(define-key map "s" 'isearch-forward)
(define-key map "g" 'perkeep-find-permanode-from-buffer)
map)
"Local keymap for perkeep mode buffers.")
(defgroup perkeep-faces nil
"Faces used by perkeep."
:group 'perkeep
:group 'faces)
(defface perkeep-permanode-ref
'((t (:inherit link)))
"Face used for permanode refs."
:group 'perkeep-faces
:version "22.1")
(defvar perkeep-permanode-ref-face 'perkeep-permanode-ref
"Face name used for permanode refs.")
(defface perkeep-permanode-attribute-key
'((t (:inherit bold)))
"Face used for permanode attribute keys."
:group 'perkeep-faces
:version "22.1")
(defvar perkeep-permanode-attribute-key-face 'perkeep-permanode-attribute-key
"Face name used for permanode attribute keys.")
(defface perkeep-permanode-attribute-metadata
'((t (:inherit shadow)))
"Face used for extra metadata shown below permanode attribute values."
:group 'perkeep-faces
:version "22.1")
(defvar perkeep-permanode-attribute-metadata-face 'perkeep-permanode-attribute-metadata
"Face name used for permanode attribute metadata.")
(defvar perkeep-font-lock-keywords
(list
(list "^sha[0-9]+-[a-z0-9]+$" '(0 perkeep-permanode-ref-face))
(list "^\t[^\t].*$" '(0 perkeep-permanode-attribute-key-face))
(list "^\t\t\t.*$" '(0 perkeep-permanode-attribute-metadata-face))
))
(defcustom perkeep-mode-hook nil
"Run at the very end of `perkeep-mode'."
:group 'perkeep
:type 'hook)
;;;###autoload
(defun perkeep-mode ()
"Mode for browsing perkeep search results.
Type \\[perkeep-follow-permanode] to visit the permanode below the
cursor. Permanodes with a camliContent attribute will be fetched from
perkeep and shown an another buffer. camliMember and camliPath
attributes of a permanodes without a camliContent attribute will be
searched for in another buffer.
Type \\[perkeep-previous-permanode] to move the cursor to the previous permanode.
Type \\[perkeep-next-permanode] to move the cursor to the next permanode."
(kill-all-local-variables)
(use-local-map perkeep-mode-map)
(setq major-mode 'perkeep-mode
mode-name "perkeep"
;; case-fold-search nil
buffer-read-only t
selective-display t) ; for subdirectory hiding
(setq-local tab-width 2)
(setq-local font-lock-defaults
'(perkeep-font-lock-keywords t nil nil beginning-of-line))
(font-lock-ensure)
(run-mode-hooks 'perkeep-mode-hook)
)
(defcustom perkeep-permanode-created-hook nil
"Run after `perkeep-save-buffer' has created a permanode in perkeep.
The permanode's ref is passed as argument.
This hook can be used to add custom attributes to created
permanodes. For example adding a todo tag for later refinement:
(add-hook
'perkeep-permanode-created-hook
(lambda (permanode-ref)
(perkeep-persist-claim
(perkeep-add-attribute-claim permanode-ref \"tag\" \"todo\"))))
"
:group 'perkeep
:type 'hook)
(defcustom perkeep-buffer-saved-hook nil
"Run after a successful save by `perkeep-save-buffer' into perkeep.
The permanode's ref is passed as argument."
:group 'perkeep
:type 'hook)
;;;###autoload
(defun perkeep-save-buffer ()
"Saves the current buffer into perkeep.
This will update the content of the visited permanode or create a
new one if this buffer has not yet visited a permanode. Newly
created permanodes will be attached to this buffer after
creation."
(interactive)
(let (permanode-ref)
(deferred:$
(deferred:next
(lambda ()
(if (local-variable-p 'perkeep-permanode-ref)
(deferred:next
(lambda ()
(message "Saving to permanode %s..." perkeep-permanode-ref)
perkeep-permanode-ref))
(message "Saving to new permanode...")
(deferred:$
(perkeep--create-permanode)
(deferred:nextc it
(lambda (permanode-ref)
(setq-local perkeep-permanode-ref permanode-ref)
(perkeep-sourced-mode)
(-each perkeep-permanode-created-hook
(lambda (hook)
(funcall hook permanode-ref)))
permanode-ref))))))
(deferred:nextc it
(lambda (pr)
(setq permanode-ref pr)
(perkeep--save-buffer-to-existing-permanode permanode-ref)))
(deferred:nextc it
(lambda ()
(message "Wrote permanode %s" permanode-ref)
(-each perkeep-buffer-saved-hook
(lambda (hook)
(funcall hook permanode-ref))))))))
(defun perkeep--create-permanode ()
(perkeep-persist-claim
(perkeep-create-permanode-claim
(format-message "%s" (/ (float (random most-positive-fixnum)) most-positive-fixnum)))))
(defun perkeep--save-buffer-to-existing-permanode (permanode-ref)
(deferred:$
(perkeep--upload-form
`(("ui-upload-file-helper-form" . (,(perkeep--buffer-perkeep-file-name) :data ,(buffer-string)))))
(deferred:nextc it
(lambda (buffer-content-ref)
(perkeep-persist-claim
(perkeep-set-attribute-claim permanode-ref "camliContent" buffer-content-ref))))
(deferred:nextc it
(lambda ()
(set-buffer-modified-p ())))))
(defun perkeep--buffer-perkeep-file-name ()
(if buffer-file-name
(file-name-nondirectory buffer-file-name)
(buffer-name)))
(defun perkeep-persist-claim (claim)
"Persists a given claim in perkeep.
The functions `perkeep-create-permanode-claim' or
`perkeep-set-attribute-claim' can be used to produce claims for
this function."
(deferred:$
(perkeep--sign claim)
(deferred:nextc it
(lambda (signed-claim)
(let (claim-key)
(setq claim-key (concat "sha224-" (secure-hash 'sha224 signed-claim)))
(perkeep--upload-claim
`((,claim-key . ("blob" :data ,(eval signed-claim))))))))
(deferred:nextc it
(lambda (response)
;; TODO define a more sane return value of the perkeep-persist-claim function
(cdr
(assoc-string "blobRef"
(aref
(cdr
(assoc-string "received" response)) 0)))))))
(defun perkeep-create-permanode-claim (rand)
`(
("camliType" . "permanode")
("random" . ,rand)
))
(defun perkeep-set-attribute-claim (permanode-ref key value)
`(
("camliType" . "claim")
("permaNode" . ,(eval permanode-ref))
("claimType" . "set-attribute")
("claimDate" . ,(perkeep--now))
("attribute" . ,(eval key))
("value" . ,(eval value))
))
(defun perkeep-add-attribute-claim (permanode-ref key value)
`(
("camliType" . "claim")
("permaNode" . ,(eval permanode-ref))
("claimType" . "add-attribute")
("claimDate" . ,(perkeep--now))
("attribute" . ,(eval key))
("value" . ,(eval value))
))
;; TODO del attribute claim with and without value
;; (perkeep--now)
(defun perkeep--now ()
(format-time-string "%FT%T.%3NZ" nil "UTC0"))
(defvar perkeep-sourced-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-x C-s") 'perkeep-save-buffer)
map)
"Keymap for `perkeep-sourced-mode'.")
(define-minor-mode perkeep-sourced-mode
"Saves the buffer into perkeep instead of into a file."
(interactive (list (or current-prefix-arg 'toggle)))
(let ((enable
(if (eq arg 'toggle)
(not perkeep-sourced-mode)
(> (prefix-numeric-value arg) 0))))
(if enable
(perkeep-enable-perkeep-sourced-mode)
(perkeep-disable-perkeep-sourced-mode)))
:keymap perkeep-sourced-mode-map)
(defun perkeep-enable-perkeep-sourced-mode ()
)
(defun perkeep-disable-perkeep-sourced-mode ()
)
(provide 'perkeep)
;; (require 'perkeep)
;; (setf debug-on-error t)
;; (setf deferred:debug-on-signal t)
;; (perkeep--default-ui-config `(lambda (data) (message "hello %S" data)))
;; (setq server (perkeep-client-config-server))
;; (cdr (assoc-string "url" server))
;; TODO (put 'funny-mode 'mode-class 'special)