-
-
Notifications
You must be signed in to change notification settings - Fork 476
/
org-roam.el
1926 lines (1740 loc) · 80.2 KB
/
org-roam.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
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
;;; org-roam.el --- Roam Research replica with Org-mode -*- coding: utf-8; lexical-binding: t; -*-
;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
;; URL: https://github.com/org-roam/org-roam
;; Keywords: org-mode, roam, convenience
;; Version: 1.2.3
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2"))
;; This file is NOT part of GNU Emacs.
;; 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, 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 GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;;; Commentary:
;;
;; This library is an attempt at injecting Roam functionality into Org-mode.
;; This is achieved primarily through building caches for forward links,
;; backward links, and file titles.
;;
;;
;;; Code:
;;;; Dependencies
(require 'org)
(require 'org-element)
(require 'org-id)
(require 'ob-core) ;for org-babel-parse-header-arguments
(require 'ansi-color) ; org-roam--list-files strip ANSI color codes
(require 'cl-lib)
(require 'dash)
(require 'f)
(require 'rx)
(require 's)
(require 'seq)
(eval-when-compile (require 'subr-x))
;;;; Features
(require 'org-roam-compat)
(require 'org-roam-macs)
;; These features should be able to be loaded order independently.
;; @TODO: implement something akin to `org-modules' that allows
;; selectively loading different sets of features.
;; ~NV [2020-05-22 Fri]
(require 'org-roam-faces)
(require 'org-roam-buffer)
(require 'org-roam-completion)
(require 'org-roam-capture)
(require 'org-roam-dailies)
(require 'org-roam-db)
(require 'org-roam-doctor)
(require 'org-roam-graph)
(require 'org-roam-link)
;;;; Declarations
;; From org-ref-core.el
(defvar org-ref-cite-types)
(declare-function org-ref-split-and-strip-string "ext:org-ref-utils" (string))
;; From org-id.el
(defvar org-id-link-to-org-use-id)
(declare-function org-id-find-id-in-file "ext:org-id" (id file &optional markerp))
;;;; Customizable variables
(defgroup org-roam nil
"Roam Research replica in Org-mode."
:group 'org
:prefix "org-roam-"
:link '(url-link :tag "Github" "https://github.com/org-roam/org-roam")
:link '(url-link :tag "Online Manual" "https://www.orgroam.com/manual.html"))
(defcustom org-roam-directory (expand-file-name "~/org-roam/")
"Default path to Org-roam files.
All Org files, at any level of nesting, are considered part of the Org-roam."
:type 'directory
:group 'org-roam)
(defcustom org-roam-encrypt-files nil
"Whether to encrypt new files. If true, create files with .gpg extension."
:type 'boolean
:group 'org-roam)
(defcustom org-roam-file-extensions '("org")
"Detected file extensions to include in the Org-roam ecosystem.
The first item in the list is used as the default file extension.
While the file extensions may be different, the file format needs
to be an `org-mode' file, and it is the user's responsibility to
ensure that."
:type '(repeat string)
:group 'org-roam)
(defcustom org-roam-file-exclude-regexp nil
"Files matching this regular expression are excluded from the Org-roam."
:type '(choice
(string :tag "Regular expression matching files to ignore")
(const :tag "Include everything" nil))
:group 'org-roam)
(defcustom org-roam-find-file-function nil
"Function called when visiting files in Org-roam commands.
If nil, `find-file' is used."
:type 'function
:group 'org-roam)
(defcustom org-roam-include-type-in-ref-path-completions nil
"When t, include the type in ref-path completions.
Note that this only affects interactive calls.
See `org-roam--get-ref-path-completions' for details."
:type 'boolean
:group 'org-roam)
(defcustom org-roam-index-file "index.org"
"Path to the Org-roam index file.
The path can be a string or a function. If it is a string, it
should be the path (absolute or relative to `org-roam-directory')
to the index file. If it is is a function, the function should
return the path to the index file. Otherwise, the index is
assumed to be a note in `org-roam-directory' whose title is
'Index'."
:type '(choice
(string :tag "Path to index" "%s")
(function :tag "Function to generate the path"))
:group 'org-roam)
(defcustom org-roam-link-title-format "%s"
"The formatter used when inserting Org-roam links that use their title.
Formatter may be a function that takes title as its only argument."
:type '(choice
(string :tag "String Format" "%s")
(function :tag "Custom function"))
:group 'org-roam)
(defcustom org-roam-prefer-id-links t
"If non-nil, use ID for linking instead where available."
:type 'boolean
:group 'org-roam)
(defcustom org-roam-list-files-commands
(if (member system-type '(windows-nt ms-dos cygwin))
nil
'(find rg))
"Commands that will be used to find Org-roam files.
It should be a list of symbols or cons cells representing any of the following
supported file search methods.
The commands will be tried in order until an executable for a command is found.
The Elisp implementation is used if no command in the list is found.
`rg'
Use ripgrep as the file search method.
Example command: rg /path/to/dir/ --files -g \"*.org\" -g \"*.org.gpg\"
`find'
Use find as the file search method.
Example command:
find /path/to/dir -type f \( -name \"*.org\" -o -name \"*.org.gpg\" \)
By default, `executable-find' will be used to look up the path to the
executable. If a custom path is required, it can be specified together with the
method symbol as a cons cell. For example: '(find (rg . \"/path/to/rg\"))."
:type '(set (const :tag "find" find)
(const :tag "rg" rg)))
(defcustom org-roam-tag-separator ","
"String to use to separate tags when `org-roam-tag-sources' is non-nil."
:type 'string
:group 'org-roam)
(defcustom org-roam-tag-sort nil
"When non-nil, sort the tags in the completions.
When t, sort the tags alphabetically, regardless of case.
`org-roam-tag-sort' can also be a list of arguments to be applied
to `cl-sort'. For example, these are the arguments used when
`org-roam-tag-sort' is set to t:
\('string-lessp :key 'downcase)
Only relevant when `org-roam-tag-sources' is non-nil."
:type '(choice
(boolean)
(list :tag "Arguments to cl-loop"))
:group 'org-roam)
(defcustom org-roam-tag-sources '(prop)
"Sources to obtain tags from.
It should be a list of symbols representing any of the following
extraction methods:
`prop'
Extract tags from the #+roam_tags property.
Tags are space delimited.
Tags may contain spaces if they are double-quoted.
e.g. #+roam_tags: TAG \"tag with spaces\"
`vanilla'
Extract vanilla `org-mode' tags, including #+FILETAGS and
inherited tags.
`all-directories'
Extract sub-directories relative to `org-roam-directory'.
That is, if a file is located at relative path foo/bar/file.org,
the file will have tags \"foo\" and \"bar\".
`last-directory'
Extract the last directory relative to `org-roam-directory'.
That is, if a file is located at relative path foo/bar/file.org,
the file will have tag \"bar\".
`first-directory'
Extract the first directory relative to `org-roam-directory'.
That is, if a file is located at relative path foo/bar/file.org,
the file will have tag \"foo\"."
:type '(set (const :tag "#+roam_tags" prop)
(const :tag "buffer org tags" vanilla)
(const :tag "sub-directories" all-directories)
(const :tag "parent directory" last-directory)
(const :tag "first sub-directory" first-directory)))
(defcustom org-roam-title-to-slug-function #'org-roam--title-to-slug
"Function to be used in converting a title to the filename slug.
Function should return a filename string based on title."
:type 'function
:group 'org-roam)
(defcustom org-roam-slug-trim-chars
'(;; Combining Diacritical Marks https://www.unicode.org/charts/PDF/U0300.pdf
768 ; U+0300 COMBINING GRAVE ACCENT
769 ; U+0301 COMBINING ACUTE ACCENT
770 ; U+0302 COMBINING CIRCUMFLEX ACCENT
771 ; U+0303 COMBINING TILDE
772 ; U+0304 COMBINING MACRON
774 ; U+0306 COMBINING BREVE
775 ; U+0307 COMBINING DOT ABOVE
776 ; U+0308 COMBINING DIAERESIS
777 ; U+0309 COMBINING HOOK ABOVE
778 ; U+030A COMBINING RING ABOVE
780 ; U+030C COMBINING CARON
795 ; U+031B COMBINING HORN
803 ; U+0323 COMBINING DOT BELOW
804 ; U+0324 COMBINING DIAERESIS BELOW
805 ; U+0325 COMBINING RING BELOW
807 ; U+0327 COMBINING CEDILLA
813 ; U+032D COMBINING CIRCUMFLEX ACCENT BELOW
814 ; U+032E COMBINING BREVE BELOW
816 ; U+0330 COMBINING TILDE BELOW
817 ; U+0331 COMBINING MACRON BELOW
)
"Characters to trim from Unicode normalization for slug.
By default, the characters are specified to remove Diacritical
Marks from the Latin alphabet."
:type '(repeat character)
:group 'org-roam)
(defcustom org-roam-title-sources '((title headline) alias)
"The list of sources from which to retrieve a note title.
Each element in the list is either:
1. a symbol -- this symbol corresponds to a title retrieval
function, which returns the list of titles for the current buffer
2. a list of symbols -- symbols in the list are treated as
with (1). The return value of this list is the first symbol in
the list returning a non-nil value.
The return results of the root list are concatenated.
For example the setting: '((title headline) alias) means the following:
1. Return the 'title + 'alias, if the title of current buffer is non-empty;
2. Or return 'headline + 'alias otherwise.
The currently supported symbols are:
`title'
The \"#+title\" property of org file.
`alias'
The \"#+roam_alias\" property of the org file, using
space-delimited strings.
`headline'
The first headline in the org file."
:type '(repeat
(choice
(repeat symbol)
(symbol)))
:group 'org-roam)
(defcustom org-roam-file-completion-tag-position 'prepend
"Prepend, append, or omit tags from the file titles during completion."
:type '(choice (const :tag "Prepend" prepend)
(const :tag "Append" append)
(const :tag "Omit" omit))
:group 'org-roam)
(defcustom org-roam-enable-headline-linking t
"Enable linking to headlines.
This includes automatic :ID: creation and scanning of :ID:s for
org-roam database."
:type 'boolean
:group 'org-roam)
(defcustom org-roam-verbose t
"Echo messages that are not errors."
:type 'boolean
:group 'org-roam)
(defvar org-roam-completion-functions nil
"List of functions to be used with `completion-at-point' for Org-roam.")
;;;; Dynamic variables
(defvar org-roam-last-window nil
"Last window `org-roam' was called from.")
(defvar-local org-roam-file-name nil
"The corresponding file for a temp buffer.
This is set by `org-roam--with-temp-buffer', to allow throwing of
descriptive warnings when certain operations fail (e.g. parsing).")
(defvar org-roam--org-link-bracket-typed-re
(rx (seq "[["
(group (+? anything))
":"
(group
(one-or-more
(or (not (any "[]\\"))
(and "\\" (zero-or-more "\\\\") (any "[]"))
(and (one-or-more "\\") (not (any "[]"))))))
"]"
(opt "[" (group (+? anything)) "]")
"]"))
"Matches a typed link in double brackets.")
;;;; Utilities
(defun org-roam--plist-to-alist (plist)
"Return an alist of the property-value pairs in PLIST."
(let (res)
(while plist
(let ((prop (intern (substring (symbol-name (pop plist)) 1 nil)))
(val (pop plist)))
(push (cons prop val) res)))
res))
(defun org-roam--url-p (path)
"Check if PATH is a URL.
Assume the protocol is not present in PATH; e.g. URL `https://google.com' is
passed as `//google.com'."
(string-prefix-p "//" path))
;;;; File functions and predicates
(defun org-roam--file-name-extension (filename)
"Return file name extension for FILENAME.
Like `file-name-extension', but does not strip version number."
(save-match-data
(let ((file (file-name-nondirectory filename)))
(if (and (string-match "\\.[^.]*\\'" file)
(not (eq 0 (match-beginning 0))))
(substring file (+ (match-beginning 0) 1))))))
(defun org-roam--org-file-p (path)
"Check if PATH is pointing to an org file."
(let ((ext (org-roam--file-name-extension path)))
(when (string= ext "gpg") ; Handle encrypted files
(setq ext (org-roam--file-name-extension (file-name-sans-extension path))))
(member ext org-roam-file-extensions)))
(defun org-roam--org-roam-file-p (&optional file)
"Return t if FILE is part of Org-roam system, nil otherwise.
If FILE is not specified, use the current buffer's file-path."
(when-let ((path (or file
org-roam-file-name
(-> (buffer-base-buffer)
(buffer-file-name)))))
(save-match-data
(and
(org-roam--org-file-p path)
(not (and org-roam-file-exclude-regexp
(string-match-p org-roam-file-exclude-regexp path)))
(f-descendant-of-p path (expand-file-name org-roam-directory))))))
(defun org-roam--shell-command-files (cmd)
"Run CMD in the shell and return a list of files. If no files are found, an empty list is returned."
(--> cmd
(shell-command-to-string it)
(ansi-color-filter-apply it)
(split-string it "\n")
(seq-filter #'s-present? it)))
(defun org-roam--list-files-search-globs (exts)
"Given EXTS, return a list of search globs.
E.g. (\".org\") => (\"*.org\" \"*.org.gpg\")"
(append
(mapcar (lambda (ext) (s-wrap (concat "*." ext) "\"")) exts)
(mapcar (lambda (ext) (s-wrap (concat "*." ext ".gpg") "\"")) exts)))
(defun org-roam--list-files-rg (executable dir)
"Return all Org-roam files located recursively within DIR, using ripgrep, provided as EXECUTABLE."
(let* ((globs (org-roam--list-files-search-globs org-roam-file-extensions))
(command (s-join " " `(,executable "-L" ,dir "--files"
,@(mapcar (lambda (glob) (concat "-g " glob)) globs)))))
(org-roam--shell-command-files command)))
(defun org-roam--list-files-find (executable dir)
"Return all Org-roam files located recursively within DIR, using find, provided as EXECUTABLE."
(let* ((globs (org-roam--list-files-search-globs org-roam-file-extensions))
(command (s-join " " `(,executable "-L" ,dir "-type f \\("
,(s-join " -o " (mapcar (lambda (glob) (concat "-name " glob)) globs)) "\\)"))))
(org-roam--shell-command-files command)))
;; Emacs 26 does not have FOLLOW-SYMLINKS in `directory-files-recursively'
(defun org-roam--directory-files-recursively (dir regexp
&optional include-directories predicate
follow-symlinks)
"Return list of all files under directory DIR whose names match REGEXP.
This function works recursively. Files are returned in \"depth
first\" order, and files from each directory are sorted in
alphabetical order. Each file name appears in the returned list
in its absolute form.
By default, the returned list excludes directories, but if
optional argument INCLUDE-DIRECTORIES is non-nil, they are
included.
PREDICATE can be either nil (which means that all subdirectories
of DIR are descended into), t (which means that subdirectories that
can't be read are ignored), or a function (which is called with
the name of each subdirectory, and should return non-nil if the
subdirectory is to be descended into).
If FOLLOW-SYMLINKS is non-nil, symbolic links that point to
directories are followed. Note that this can lead to infinite
recursion."
(let* ((result nil)
(files nil)
(dir (directory-file-name dir))
;; When DIR is "/", remote file names like "/method:" could
;; also be offered. We shall suppress them.
(tramp-mode (and tramp-mode (file-remote-p (expand-file-name dir)))))
(dolist (file (sort (file-name-all-completions "" dir)
'string<))
(unless (member file '("./" "../"))
(if (directory-name-p file)
(let* ((leaf (substring file 0 (1- (length file))))
(full-file (concat dir "/" leaf)))
;; Don't follow symlinks to other directories.
(when (and (or (not (file-symlink-p full-file))
(and (file-symlink-p full-file)
follow-symlinks))
;; Allow filtering subdirectories.
(or (eq predicate nil)
(eq predicate t)
(funcall predicate full-file)))
(let ((sub-files
(if (eq predicate t)
(condition-case nil
(org-roam--directory-files-recursively
full-file regexp include-directories
predicate follow-symlinks)
(file-error nil))
(org-roam--directory-files-recursively
full-file regexp include-directories
predicate follow-symlinks))))
(setq result (nconc result sub-files))))
(when (and include-directories
(string-match regexp leaf))
(setq result (nconc result (list full-file)))))
(when (string-match regexp file)
(push (concat dir "/" file) files)))))
(nconc result (nreverse files))))
(defun org-roam--list-files-elisp (dir)
"Return all Org-roam files located recursively within DIR, using elisp."
(let ((regex (concat "\\.\\(?:"(mapconcat #'regexp-quote org-roam-file-extensions "\\|" )"\\)\\(?:\\.gpg\\)?\\'"))
result)
(dolist (file (org-roam--directory-files-recursively dir regex nil nil t) result)
(when (and (file-readable-p file) (org-roam--org-file-p file))
(push file result)))))
(defun org-roam--list-files (dir)
"Return all Org-roam files located recursively within DIR.
Use external shell commands if defined in `org-roam-list-files-commands'."
(let (path exe)
(cl-dolist (cmd org-roam-list-files-commands)
(pcase cmd
(`(,e . ,path)
(setq path (executable-find path)
exe (symbol-name e)))
((pred symbolp)
(setq path (executable-find (symbol-name cmd))
exe (symbol-name cmd)))
(wrong-type
(signal 'wrong-type-argument
`((consp symbolp)
,wrong-type))))
(when path (cl-return)))
(if-let* ((files (when path
(let ((fn (intern (concat "org-roam--list-files-" exe))))
(unless (fboundp fn) (user-error "%s is not an implemented search method" fn))
(funcall fn path (format "\"%s\"" dir)))))
(files (seq-filter #'org-roam--org-roam-file-p files))
(files (mapcar #'expand-file-name files))) ; canonicalize names
files
(org-roam--list-files-elisp dir))))
(defun org-roam--list-all-files ()
"Return a list of all Org-roam files within `org-roam-directory'."
(org-roam--list-files (expand-file-name org-roam-directory)))
;;;; Org extraction functions
(defun org-roam--extract-global-props-drawer (props)
"Extract PROPS from the file-level property drawer in Org."
(let (ret)
(org-with-point-at 1
(dolist (prop props ret)
(when-let ((v (org-entry-get (point) prop)))
(push (cons prop v) ret))))))
(defun org-roam--collect-keywords (keywords)
"Collect all Org KEYWORDS in the current buffer."
(if (functionp 'org-collect-keywords)
(org-collect-keywords keywords)
(let ((buf (org-element-parse-buffer))
res)
(dolist (k keywords)
(let ((p (org-element-map buf 'keyword
(lambda (kw)
(when (string-equal (org-element-property :key kw) k)
(org-element-property :value kw)))
:first-match nil)))
(push (cons k p) res)))
res)))
(defun org-roam--extract-global-props-keyword (keywords)
"Extract KEYWORDS from the current Org buffer."
(let (ret)
(pcase-dolist (`(,key . ,values) (org-roam--collect-keywords keywords))
(dolist (value values)
(push (cons key value) ret)))
ret))
(defun org-roam--extract-global-props (props)
"Extract PROPS from the current Org buffer.
Props are extracted from both the file-level property drawer (if
any), and Org keywords. Org keywords take precedence."
(append
(org-roam--extract-global-props-keyword props)
(org-roam--extract-global-props-drawer props)))
(defun org-roam--get-outline-path ()
"Return the outline path to the current entry.
An outline path is a list of ancestors for current headline, as a
list of strings. Statistics cookies are removed and links are
kept.
When optional argument WITH-SELF is non-nil, the path also
includes the current headline."
(org-with-wide-buffer
(save-match-data
(and (or (condition-case nil
(org-back-to-heading t)
(error nil))
(org-up-heading-safe))
(reverse (org-roam--get-outline-path-1))))))
(defun org-roam--get-outline-path-1 ()
"Return outline path to current headline.
Outline path is a list of strings, in reverse order. See
`org-roam--get-outline-path' for details.
Assume buffer is widened and point is on a headline."
(when org-complex-heading-regexp
(let ((heading (let ((case-fold-search nil))
(looking-at org-complex-heading-regexp)
(if (not (match-end 4)) ""
;; Remove statistics cookies.
(org-trim
(replace-regexp-in-string
"\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
(match-string-no-properties 4)))))))
(if (org-up-heading-safe)
(cons heading (org-roam--get-outline-path-1))
(list heading)))))
(defun org-roam--extract-links (&optional file-path)
"Extracts all link items within the current buffer.
Link items are of the form:
[source dest type properties]
This is the format that emacsql expects when inserting into the database.
FILE-FROM is typically the buffer file path, but this may not exist, for example
in temp buffers. In cases where this occurs, we do know the file path, and pass
it as FILE-PATH."
(require 'org-ref nil t)
(setq file-path (or file-path
org-roam-file-name
(buffer-file-name)))
(save-excursion
(let (links)
(org-element-map (org-element-parse-buffer) 'link
(lambda (link)
(goto-char (org-element-property :begin link))
(let* ((type (org-roam--collate-types (org-element-property :type link)))
(path (org-element-property :path link))
(properties (list :outline (org-roam--get-outline-path)
:point (point)))
(names (pcase type
("id"
(when-let ((file-path (org-roam-id-get-file path)))
(list file-path)))
("cite" (list path))
("website" (list path))
("fuzzy" (list path))
("roam" (list path))
(_ (if (or (file-remote-p path)
(org-roam--url-p path))
(list path)
(let ((file-maybe (expand-file-name path (file-name-directory file-path))))
(if (f-exists? file-maybe)
(list file-maybe)
(list path))))))))
(dolist (name names)
(when name
(push (vector file-path name type properties) links))))))
links)))
(defun org-roam--extract-ids (&optional file-path)
"Extract all IDs within the current buffer.
If FILE-PATH is nil, use the current file."
(setq file-path (or file-path org-roam-file-name (buffer-file-name)))
(let (result)
;; We need to handle the special case of the file property drawer (at outline level 0)
(org-with-point-at (point-min)
(when-let ((before-first-heading (= 0 (org-outline-level)))
(id (org-entry-get nil "ID")))
(push (vector id file-path 0) result)))
(org-map-region
(lambda ()
(when-let ((id (org-entry-get nil "ID")))
(push (vector id file-path (org-outline-level)) result)))
(point-min) (point-max))
result))
(defun org-roam--extract-titles-title ()
"Return title from \"#+title\" of the current buffer."
(let* ((prop (org-roam--extract-global-props '("TITLE")))
(title (cdr (assoc "TITLE" prop))))
(when title
(list title))))
(defun org-roam--extract-titles-alias ()
"Return the aliases from the current buffer.
Reads from the \"roam_alias\" property."
(let* ((prop (org-roam--extract-global-props '("ROAM_ALIAS")))
(aliases (or (cdr (assoc "ROAM_ALIAS" prop))
"")))
(condition-case nil
(split-string-and-unquote aliases)
(error
(progn
(lwarn '(org-roam) :error
"Failed to parse aliases for buffer: %s. Skipping"
(or org-roam-file-name
(buffer-file-name)))
nil)))))
(defun org-roam--extract-titles-headline ()
"Return the first headline of the current buffer."
(let ((headline (save-excursion
(goto-char (point-min))
;; "What happens if a heading star was quoted
;; before the first heading?"
;; - `org-map-region' also does this
;; - Org already breaks badly when you do that;
;; precede the heading star with a ",".
(re-search-forward org-outline-regexp-bol nil t)
(org-entry-get nil "ITEM"))))
(when headline
(list headline))))
(defun org-roam--extract-titles (&optional sources nested)
"Extract the titles from current buffer using SOURCES.
If NESTED, return the first successful result from SOURCES."
(org-with-wide-buffer
(let (coll res)
(cl-dolist (source (or sources
org-roam-title-sources))
(setq res (if (symbolp source)
(funcall (intern (concat "org-roam--extract-titles-" (symbol-name source))))
(org-roam--extract-titles source t)))
(when res
(if (not nested)
(setq coll (nconc coll res))
(setq coll res)
(cl-return))))
(-uniq coll))))
(defun org-roam--extract-tags-all-directories (file)
"Extract tags from using the directory path FILE.
All sub-directories relative to `org-roam-directory' are used as tags."
(when-let ((dir-relative (file-name-directory
(file-relative-name file (expand-file-name org-roam-directory)))))
(f-split dir-relative)))
(defun org-roam--extract-tags-last-directory (file)
"Extract tags from using the directory path FILE.
The final directory component is used as a tag."
(when-let ((dir-relative (file-name-directory
(file-relative-name file (expand-file-name org-roam-directory)))))
(last (f-split dir-relative))))
(defun org-roam--extract-tags-first-directory (file)
"Extract tags from path FILE.
The first directory component after `org-roam-directory' is used as a
tag."
(when-let ((dir-relative (file-name-directory
(file-relative-name file (expand-file-name org-roam-directory)))))
(list (car (f-split dir-relative)))))
(defun org-roam--extract-tags-prop (_file)
"Extract tags from the current buffer's \"#roam_tags\" global property."
(let* ((prop (or (cdr (assoc "ROAM_TAGS" (org-roam--extract-global-props '("ROAM_TAGS"))))
"")))
(condition-case nil
(split-string-and-unquote prop)
(error
(progn
(lwarn '(org-roam) :error
"Failed to parse tags for buffer: %s. Skipping"
(or org-roam-file-name
(buffer-file-name)))
nil)))))
(defun org-roam--extract-tags-vanilla (_file)
"Extract vanilla `org-mode' tags.
This includes all tags used in the buffer."
(-flatten (org-get-buffer-tags)))
(defun org-roam--extract-tags (&optional file)
"Extract tags from the current buffer.
If file-path FILE, use it to determine the directory tags.
Tags are obtained via:
1. Directory tags: Relative to `org-roam-directory': each folder
path is considered a tag.
2. The key #+roam_tags."
(let* ((file (or file (buffer-file-name (buffer-base-buffer))))
(tags (-uniq
(mapcan (lambda (source)
(funcall (intern (concat "org-roam--extract-tags-"
(symbol-name source)))
file))
org-roam-tag-sources))))
(pcase org-roam-tag-sort
('nil tags)
((pred booleanp) (cl-sort tags 'string-lessp :key 'downcase))
(`(,(pred symbolp) . ,_)
(apply #'cl-sort (push tags org-roam-tag-sort)))
(wrong-type (signal 'wrong-type-argument
`((booleanp (list symbolp))
,wrong-type))))))
(defun org-roam--collate-types (type)
"Collate TYPE into a parent type.
Packages like `org-ref' introduce many different link prefixes,
but we collate them under the same parent type to clean up
backlinks."
(cond ((and (boundp 'org-ref-cite-types)
(member type org-ref-cite-types))
"cite")
((member type '("http" "https"))
"website")
(t type)))
(defun org-roam--split-ref (ref)
"Processes REF into its type and path.
Returns a cons cell of type and path if ref is a valid ref."
(save-match-data
(when (string-match org-link-plain-re ref)
(cons (org-roam--collate-types (match-string 1 ref))
(match-string 2 ref)))))
(defun org-roam--extract-refs ()
"Extract all refs (ROAM_KEY statements) from the current buffer.
Each ref is returned as a cons of its type and its key."
(let (refs)
(pcase-dolist
(`(,_ . ,roam-key)
(org-roam--extract-global-props '("ROAM_KEY")))
(pcase roam-key
('nil nil)
((pred string-empty-p)
(user-error "Org property #+roam_key cannot be empty"))
(ref
(when-let ((r (org-roam--split-ref ref)))
(push r refs)))))
refs))
(defun org-roam--extract-ref ()
"Extract the ref from current buffer and return the type and the key of the ref."
(car (org-roam--extract-refs)))
;;;; Title/Path/Slug conversion
(defun org-roam--path-to-slug (path)
"Return a slug from PATH."
(-> path
(file-relative-name (expand-file-name org-roam-directory))
(file-name-sans-extension)))
(defun org-roam--title-to-slug (title)
"Convert TITLE to a filename-suitable slug."
(cl-flet* ((nonspacing-mark-p (char)
(memq char org-roam-slug-trim-chars))
(strip-nonspacing-marks (s)
(ucs-normalize-NFC-string
(apply #'string (seq-remove #'nonspacing-mark-p
(ucs-normalize-NFD-string s)))))
(cl-replace (title pair)
(replace-regexp-in-string (car pair) (cdr pair) title)))
(let* ((pairs `(("[^[:alnum:][:digit:]]" . "_") ;; convert anything not alphanumeric
("__*" . "_") ;; remove sequential underscores
("^_" . "") ;; remove starting underscore
("_$" . ""))) ;; remove ending underscore
(slug (-reduce-from #'cl-replace (strip-nonspacing-marks title) pairs)))
(downcase slug))))
(defun org-roam-format-link (target &optional description type link-type)
"Formats an org link for a given file TARGET, link DESCRIPTION and link TYPE.
TYPE defaults to \"file\". LINK-TYPE is the type of file link to
be generated. Here, we also check if there is an ID for the
file."
(setq type (or type "file"))
(when-let ((id (and org-roam-prefer-id-links
(string-equal type "file")
(caar (org-roam-db-query [:select [id] :from ids
:where (= file $s1)
:and (= level 0)
:limit 1]
target)))))
(setq type "id" target id))
(when (string-equal type "file")
(setq target (org-roam-link-get-path target link-type)))
(setq description
(if (functionp org-roam-link-title-format)
(funcall org-roam-link-title-format description type)
(format org-roam-link-title-format description)))
(org-link-make-string (concat type ":" target) description))
(defun org-roam--add-tag-string (str tags)
"Add TAGS to STR.
Depending on the value of `org-roam-file-completion-tag-position', this function
prepends TAGS to STR, appends TAGS to STR or omits TAGS from STR."
(pcase org-roam-file-completion-tag-position
('prepend (concat
(when tags (propertize (format "(%s) " (s-join org-roam-tag-separator tags))
'face 'org-roam-tag))
str))
('append (concat
str
(when tags (propertize (format " (%s)" (s-join org-roam-tag-separator tags))
'face 'org-roam-tag))))
('omit str)))
(defun org-roam--get-title-path-completions ()
"Return an alist for completion.
The car is the displayed title for completion, and the cdr is a
plist containing the path and title for the file."
(let* ((rows (org-roam-db-query [:select [files:file titles:title tags:tags files:meta] :from titles
:left :join tags
:on (= titles:file tags:file)
:left :join files
:on (= titles:file files:file)]))
completions)
(setq rows (seq-sort-by (lambda (x)
(plist-get (nth 3 x) :mtime))
#'time-less-p
rows))
(dolist (row rows completions)
(pcase-let ((`(,file-path ,title ,tags) row))
(let ((k (org-roam--add-tag-string title tags))
(v (list :path file-path :title title)))
(push (cons k v) completions))))))
(defun org-roam--get-index-path ()
"Return the path to the index in `org-roam-directory'.
The path to the index can be defined in `org-roam-index-file'.
Otherwise, it is assumed to be a note in `org-roam-directory'
whose title is 'Index'."
(let ((path (pcase org-roam-index-file
((pred functionp) (funcall org-roam-index-file))
((pred stringp) org-roam-index-file)
('nil (user-error "You need to set `org-roam-index-file' before you can jump to it"))
(wrong-type (signal 'wrong-type-argument
`((functionp stringp)
,wrong-type))))))
(expand-file-name path org-roam-directory)))
;;;; dealing with file-wide properties
(defun org-roam--set-global-prop (name value)
"Set a file property called NAME to VALUE.
If the property is already set, it's value is replaced."
(org-with-point-at 1
(let ((case-fold-search t))
(if (re-search-forward (concat "^#\\+" name ":\\(.*\\)") (point-max) t)
(replace-match (concat " " value) 'fixedcase nil nil 1)
(while (and (not (eobp))
(looking-at "^[#:]"))
(if (save-excursion (end-of-line) (eobp))
(progn
(end-of-line)
(insert "\n"))
(forward-line)
(beginning-of-line)))
(insert "#+" name ": " value "\n")))))
;;;; org-roam-find-ref
(defun org-roam--get-ref-path-completions (&optional arg filter)
"Return an alist of refs to absolute path of Org-roam files.
When called interactively (i.e. when ARG is 1), formats the car
of the completion-candidates with extra information: title, tags,
and type \(when `org-roam-include-type-in-ref-path-completions'
is non-nil).
When called with a `C-u' prefix (i.e. when ARG is 4), forces the
default format without the formatting.
FILTER can either be a string or a function:
- If it is a string, it should be the type of refs to include as
candidates \(e.g. \"cite\", \"website\", etc.)
- If it is a function, it should be the name of a function that
takes three arguments: the type, the ref, and the file of the
current candidate. It should return t if that candidate is to
be included as a candidate."
(let ((rows (org-roam-db-query
[:select [refs:type refs:ref refs:file titles:title tags:tags]
:from titles
:left :join tags
:on (= titles:file tags:file)
:left :join refs :on (= titles:file refs:file)
:where refs:file :is :not :null]))
completions)
(setq rows (seq-sort-by (lambda (x)
(plist-get (nth 3 x) :mtime))
#'time-less-p
rows))
(dolist (row rows completions)
(pcase-let ((`(,type ,ref ,file-path ,title ,tags) row))
(when (pcase filter
('nil t)
((pred stringp) (string= type filter))
((pred functionp) (funcall filter type ref file-path))
(wrong-type (signal 'wrong-type-argument
`((stringp functionp)
,wrong-type))))
(let ((k (if (eq arg 1)
(concat
(when org-roam-include-type-in-ref-path-completions
(format "{%s} " type))
(org-roam--add-tag-string (format "%s (%s)" title ref)
tags))
ref))
(v (list :path file-path :type type :ref ref)))
(push (cons k v) completions)))))))
(defun org-roam--find-file (file)
"Open FILE using `org-roam-find-file-function' or `find-file'."
(funcall (or org-roam-find-file-function #'find-file) file))
(defun org-roam--find-ref (ref)
"Find and open and Org-roam file from REF if it exists.
REF should be the value of '#+roam_key:' without any
type-information (e.g. 'cite:').
Return nil if the file does not exist."
(when-let* ((completions (org-roam--get-ref-path-completions))
(file (plist-get (cdr (assoc ref completions)) :path)))
(org-roam--find-file file)))
(defun org-roam--org-roam-buffer-p (&optional buffer)