forked from lsyncd/lsyncd
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlsyncd.lua
More file actions
4317 lines (3455 loc) · 76.1 KB
/
lsyncd.lua
File metadata and controls
4317 lines (3455 loc) · 76.1 KB
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
--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- lsyncd.lua Live (Mirror) Syncing Demon
--
-- This is the "runner" part of Lsyncd. It containts all its high-level logic.
-- It works closely together with the Lsyncd core in lsyncd.c. This means it
-- cannot be runned directly from the standard lua interpreter.
--
-- This code assumes your editor is at least 100 chars wide.
--
-- License: GPLv2 (see COPYING) or any later version
-- Authors: Axel Kittenberger <[email protected]>
--
--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- require('profiler')
-- profiler.start()
--
-- A security measurement.
-- The core will exit if version ids mismatch.
--
if lsyncd_version then
-- ensures the runner is not being loaded twice
lsyncd.log(
'Error',
'You cannot use the lsyncd runner as configuration file!'
)
lsyncd.terminate( -1 )
end
lsyncd_version = '2.1.0-beta'
--
-- Hides the core interface from user scripts.
--
local _l = lsyncd
lsyncd = nil
local lsyncd = _l
_l = nil
--
-- Shortcuts (which user is supposed to be able to use them as well)
--
log = lsyncd.log
terminate = lsyncd.terminate
now = lsyncd.now
readdir = lsyncd.readdir
--
-- Coping globals to ensure userscripts don't change this.
--
local log = log
local terminate = terminate
local now = now
--
-- Predeclarations
--
local Monitors
--
-- Global: total number of processess running
--
local processCount = 0
--
-- Settings specified by command line.
--
local clSettings = { }
--
-- Settings specified by config scripts.
--
local uSettings = { }
--
-- A copy of the settings function to see if the
-- user script replaced the settings() by a table
-- ( pre Lsyncd 2.1 style )
--
local settingsSafe
--============================================================================
-- Lsyncd Prototypes
--============================================================================
--
-- Array tables error if accessed with a non-number.
--
local Array = ( function( )
-- Metatable
local mt = { }
-- on accessing a nil index.
mt.__index = function( t, k )
if type(k) ~= 'number' then
error( 'Key "'..k..'" invalid for Array', 2 )
end
return rawget( t, k )
end
-- on assigning a new index.
mt.__newindex = function( t, k, v )
if type( k ) ~= 'number' then
error( 'Key "'..k..'" invalid for Array', 2 )
end
rawset( t, k, v )
end
-- creates a new object
local function new( )
local o = { }
setmetatable( o, mt )
return o
end
--
-- Public interface
--
return { new = new }
end )( )
--
-- Count array tables error if accessed with a non-number.
--
-- Additionally they maintain their length as 'size' attribute,
-- since Lua's # operator does not work on tables whose key values are not
-- strictly linear.
--
local CountArray = ( function( )
--
-- Metatable
--
local mt = { }
--
-- Key to native table
--
local k_nt = { }
--
-- On accessing a nil index.
--
mt.__index = function( t, k )
if type( k ) ~= 'number' then
error( 'Key "'..k..'" invalid for CountArray', 2 )
end
return t[ k_nt ][ k ]
end
--
-- On assigning a new index.
--
mt.__newindex = function( t, k, v )
if type(k) ~= 'number' then
error( 'Key "'..k..'" invalid for CountArray', 2 )
end
-- value before
local vb = t[ k_nt ][ k ]
if v and not vb then
t._size = t._size + 1
elseif not v and vb then
t._size = t._size - 1
end
t[ k_nt ][ k ] = v
end
--
-- Walks through all entries in any order.
--
local function walk( self )
return pairs( self[ k_nt ] )
end
--
-- Returns the count
--
local function size( self )
return self._size
end
--
-- Creates a new count array
--
local function new( )
-- k_nt is native table, private for this object.
local o = {
_size = 0,
walk = walk,
size = size,
[k_nt] = { }
}
setmetatable(o, mt)
return o
end
--
-- Public interface
--
return { new = new }
end )( )
--
-- A queue is optimized for pushing on the right and poping on the left.
--
Queue = ( function( )
--
-- Creates a new queue.
--
local function new( )
return {
first = 1,
last = 0,
size = 0
};
end
--
-- Pushes a value on the queue.
-- Returns the last value
--
local function push( list, value )
if not value then
error('Queue pushing nil value', 2)
end
local last = list.last + 1
list.last = last
list[ last ] = value
list.size = list.size + 1
return last
end
--
-- Removes an item at pos from the Queue.
--
local function remove( list, pos )
if list[ pos ] == nil then
error('Removing nonexisting item in Queue', 2)
end
list[ pos ] = nil
-- if removing first or last element,
-- the queue limits are adjusted.
if pos == list.first then
local last = list.last
while list[ pos ] == nil and pos <= list.last do
pos = pos + 1
end
list.first = pos
elseif pos == list.last then
while list[ pos ] == nil and pos >= list.first do
pos = pos - 1
end
list.last = pos
end
-- reset the indizies if the queue is empty
if list.last < list.first then
list.first = 1
list.last = 0
end
list.size = list.size - 1
end
--
-- Queue iterator (stateless)
--
local function iter( list, pos )
pos = pos + 1
while list[ pos ] == nil and pos <= list.last do
pos = pos + 1
end
if pos > list.last then
return nil
end
return pos, list[ pos ]
end
--
-- Reverse queue iterator (stateless)
--
local function iterReverse( list, pos )
pos = pos - 1
while list[pos] == nil and pos >= list.first do
pos = pos - 1
end
if pos < list.first then
return nil
end
return pos, list[ pos ]
end
--
-- Iteraters through the queue
-- returning all non-nil pos-value entries.
--
local function qpairs( list )
return iter, list, list.first - 1
end
--
-- Iteraters backwards through the queue
-- returning all non-nil pos-value entries.
--
local function qpairsReverse( list )
return iterReverse, list, list.last + 1
end
return {
new = new,
push = push,
remove = remove,
qpairs = qpairs,
qpairsReverse = qpairsReverse
}
end )( )
--
-- Locks globals,
-- No more globals can be created after this
--
local function lockGlobals( )
local t = _G
local mt = getmetatable( t ) or { }
-- TODO try to remove the underscore exceptions
mt.__index = function( t, k )
if k ~= '_' and string.sub(k, 1, 2) ~= '__' then
error( 'Access of non-existing global "'..k..'"', 2 )
else
rawget( t, k )
end
end
mt.__newindex = function( t, k, v )
if k ~= '_' and string.sub( k, 1, 2 ) ~= '__' then
error('Lsyncd does not allow GLOBALS to be created on the fly. '..
'Declare "'..k..'" local or declare global on load.', 2)
else
rawset( t, k, v )
end
end
setmetatable( t, mt )
end
--
-- Holds the information about a delayed event for one Sync.
--
local Delay = ( function( )
--
-- Creates a new delay.
--
-- Params see below.
--
local function new( etype, sync, alarm, path, path2 )
local o = {
--
-- Type of event.
-- Can be 'Create', 'Modify', 'Attrib', 'Delete' and 'Move'
--
etype = etype,
--
-- the Sync this delay belongs to
--
sync = sync,
--
-- Latest point in time this should be catered for.
-- This value is in kernel ticks, return of the C's
-- times(NULL) call.
alarm = alarm,
--
-- Path and filename or dirname of the delay relative
-- to the syncs root.
--
-- for the directories it contains a trailing slash
--
path = path,
--
-- Used only for Moves.
-- Path and file/dirname of a move destination.
--
path2 = path2,
--
-- Status of the event. Valid stati are:
--
-- 'wait' ... the event is ready to be handled.
--
-- 'active' ... there is process running catering for this event.
--
-- 'blocked' ... this event waits for another to be handled first.
--
-- 'done' ... event has been collected. This should never be
-- visible as all references should be droped on
-- collection, nevertheless the seperate status is
-- used as insurrance everything is running correctly.
status = 'wait',
--
-- Position in the queue
--
dpos = -1,
}
return o
end
--
-- Public interface
--
return { new = new }
end )( )
--
-- Combines delays
--
local Combiner = ( function( )
--
-- The new delay is absorbed by an older one.
--
local function abso( d1, d2 )
log(
'Delay',
d2.etype, ':',d2.path,
' absorbed by ',
d1.etype,':',d1.path
)
return 'absorb'
end
--
-- The new delay replaces the old one if it's a file
--
local function refi( d1, d2 )
-- but a directory blocks
if d2.path:byte( -1 ) == 47 then
log(
'Delay',
d2.etype,':',d2.path,
' blocked by ',
d1.etype,':',d1.path
)
return 'stack'
end
log(
'Delay',
d2.etype, ':', d2.path,
' replaces ',
d1.etype, ':', d1.path
)
return 'replace'
end
--
-- The new delay replaces an older one.
--
local function repl( d1, d2 )
log(
'Delay',
d2.etype, ':', d2.path,
' replaces ',
d1.etype, ':', d1.path
)
return 'replace'
end
--
-- Two delays nullificate each other.
--
local function null( d1, d2 )
log(
'Delay',
d2.etype,':',d2.path,
' nullifies ',
d1.etype,':',d1.path
)
return 'remove'
end
--
-- Table on how to combine events that dont involve a move.
--
local combineNoMove = {
Attrib = {
Attrib = abso,
Modify = repl,
Create = repl,
Delete = repl
},
Modify = {
Attrib = abso,
Modify = abso,
Create = repl,
Delete = repl
},
Create = {
Attrib = abso,
Modify = abso,
Create = abso,
Delete = repl
},
Delete = {
Attrib = abso,
Modify = abso,
Create = refi,
Delete = abso
},
}
--
-- Combines two delays
--
local function combine( d1, d2 )
if d1.etype == 'Init' or d1.etype == 'Blanket' then
-- everything is blocked by init or blanket delays.
if d2.path2 then
log(
'Delay',
d2.etype,':',d2.path,'->',d2.path2,
' blocked by ',
d1.etype,' event'
)
else
log(
'Delay',
d2.etype,':',d2.path,
' blocked by ',
d1.etype,' event'
)
end
return 'stack'
end
-- two normal events
if d1.etype ~= 'Move' and d2.etype ~= 'Move' then
if d1.path == d2.path then
if d1.status == 'active' then
return 'stack'
end
return combineNoMove[ d1.etype ][ d2.etype ]( d1, d2 )
end
-- if one is a parent directory of another, events are blocking
if d1.path:byte(-1) == 47 and string.starts(d2.path, d1.path) or
d2.path:byte(-1) == 47 and string.starts(d1.path, d2.path)
then
return 'stack'
end
return nil
end
-- non-move event on a move.
if d1.etype == 'Move' and d2.etype ~= 'Move' then
-- if the from field could be damaged the events are stacked
if d1.path == d2.path or
d2.path:byte(-1) == 47 and string.starts(d1.path, d2.path) or
d1.path:byte(-1) == 47 and string.starts(d2.path, d1.path)
then
log(
'Delay',
d2.etype, ':', d2.path,
' blocked by ',
'Move :', d1.path,'->', d1.path2
)
return 'stack'
end
-- the event does something with the move destination
if d1.path2 == d2.path then
if d2.etype == 'Delete' or d2.etype == 'Create' then
if d1.status == 'active' then
return 'stack'
end
log(
'Delay',
d2.etype, ':', d2.path,
' turns ',
'Move :', d1.path, '->', d1.path2,
' into ',
'Delete:', d1.path
)
d1.etype = 'Delete'
d1.path2 = nil
return 'stack'
end
-- on 'Attrib' or 'Modify' simply stack on moves
return 'stack'
end
if d2.path :byte(-1) == 47 and string.starts(d1.path2, d2.path) or
d1.path2:byte(-1) == 47 and string.starts(d2.path, d1.path2)
then
log(
'Delay'
,d2.etype, ':', d2.path,
' blocked by ',
'Move:', d1.path, '->', d1.path2
)
return 'stack'
end
return nil
end
-- a move upon a non-move event
if d1.etype ~= 'Move' and d2.etype == 'Move' then
if d1.path == d2.path or d1.path == d2.path2 or
d1.path :byte(-1) == 47 and string.starts(d2.path, d1.path) or
d1.path :byte(-1) == 47 and string.starts(d2.path2, d1.path) or
d2.path :byte(-1) == 47 and string.starts(d1.path, d2.path) or
d2.path2:byte(-1) == 47 and string.starts(d1.path, d2.path2)
then
log(
'Delay',
'Move:', d2.path, '->', d2.path2,
' splits on ',
d1.etype, ':', d1.path
)
return 'split'
end
return nil
end
--
-- a move event upon a move event
--
if d1.etype == 'Move' and d2.etype == 'Move' then
-- TODO combine moves,
if d1.path == d2.path or d1.path == d2.path2 or
d1.path2 == d2.path or d2.path2 == d2.path or
d1.path :byte(-1) == 47 and string.starts(d2.path, d1.path) or
d1.path :byte(-1) == 47 and string.starts(d2.path2, d1.path) or
d1.path2:byte(-1) == 47 and string.starts(d2.path, d1.path2) or
d1.path2:byte(-1) == 47 and string.starts(d2.path2, d1.path2) or
d2.path :byte(-1) == 47 and string.starts(d1.path, d2.path) or
d2.path :byte(-1) == 47 and string.starts(d1.path2, d2.path) or
d2.path2:byte(-1) == 47 and string.starts(d1.path, d2.path2) or
d2.path2:byte(-1) == 47 and string.starts(d1.path2, d2.path2)
then
log(
'Delay',
'Move:', d2.path, '->', d1.path2,
' splits on Move:',
d1.path, '->', d1.path2
)
return 'split'
end
return nil
end
error( 'reached impossible state' )
end
--
-- Public interface
--
return { combine = combine }
end )( )
--
-- Creates inlets for syncs: the user interface for events.
--
local InletFactory = ( function( )
--
-- Table to receive the delay of an event
-- or the delay list of an event list.
--
-- Keys are events and values are delays.
--
local e2d = { }
--
-- Table to ensure the uniqueness of every event
-- related to a delay.
--
-- Keys are delay and values are events.
--
local e2d2 = { }
--
-- Allows the garbage collector to remove not refrenced
-- events.
--
setmetatable( e2d, { __mode = 'k' } )
setmetatable( e2d2, { __mode = 'v' } )
--
-- Removes the trailing slash from a path.
--
local function cutSlash( path )
if string.byte(path, -1) == 47 then
return string.sub(path, 1, -2)
else
return path
end
end
--
-- Gets the path of an event.
--
local function getPath( event )
if event.move ~= 'To' then
return e2d[ event ].path
else
return e2d[ event ].path2
end
end
--
-- Interface for user scripts to get event fields.
--
local eventFields = {
--
-- Returns a copy of the configuration as called by sync.
-- But including all inherited data and default values.
--
-- TODO give user a readonly version.
--
config = function( event )
return e2d[ event ].sync.config
end,
-----
-- Returns the inlet belonging to an event.
--
inlet = function( event )
return e2d[ event ].sync.inlet
end,
--
-- Returns the type of the event.
--
-- Can be: 'Attrib', 'Create', 'Delete', 'Modify' or 'Move',
--
etype = function( event )
return e2d[ event ].etype
end,
--
-- Events are not lists.
--
isList = function( )
return false
end,
--
-- Returns the status of the event.
--
-- Can be:
-- 'wait', 'active', 'block'.
--
status = function( event )
return e2d[ event ].status
end,
--
-- Returns true if event relates to a directory
--
isdir = function( event )
return string.byte( getPath( event ), -1 ) == 47
end,
--
-- Returns the name of the file/dir.
--
-- Includes a trailing slash for dirs.
--
name = function( event )
return string.match( getPath( event ), '[^/]+/?$' )
end,
--
-- Returns the name of the file/dir
-- excluding a trailing slash for dirs.
--
basename = function( event )
return string.match( getPath( event ), '([^/]+)/?$')
end,
---
-- Returns the file/dir relative to watch root
-- including a trailing slash for dirs.
--
path = function( event )
return getPath( event )
end,
--
-- Returns the directory of the file/dir relative to watch root
-- Always includes a trailing slash.
--
pathdir = function( event )
return string.match( getPath( event ), '^(.*/)[^/]+/?' ) or ''
end,
--
-- Returns the file/dir relativ to watch root
-- excluding a trailing slash for dirs.
--
pathname = function( event )
return cutSlash( getPath( event ) )
end,
---
-- Returns the absolute path of the watch root.
-- All symlinks are resolved.
--
source = function( event )
return e2d[ event ].sync.source
end,
--
-- Returns the absolute path of the file/dir
-- including a trailing slash for dirs.
--
sourcePath = function( event )
return e2d[ event ].sync.source .. getPath( event )
end,
--
-- Returns the absolute dir of the file/dir
-- including a trailing slash.
--
sourcePathdir = function( event )
return e2d[event].sync.source ..
( string.match( getPath( event ), '^(.*/)[^/]+/?' ) or '' )
end,
------
-- Returns the absolute path of the file/dir
-- excluding a trailing slash for dirs.
--
sourcePathname = function( event )
return e2d[ event ].sync.source .. cutSlash( getPath( event ) )
end,
--
-- Returns the configured target
--
target = function( event )
return e2d[ event ].sync.config.target
end,
--
-- Returns the relative dir/file appended to the target
-- including a trailing slash for dirs.
--
targetPath = function( event )
return e2d[ event ].sync.config.target .. getPath( event )
end,
--
-- Returns the dir of the dir/file appended to the target
-- including a trailing slash.
--
targetPathdir = function( event )
return e2d[ event ].sync.config.target ..
( string.match( getPath( event ), '^(.*/)[^/]+/?' ) or '' )
end,
--
-- Returns the relative dir/file appended to the target
-- excluding a trailing slash for dirs.
--
targetPathname = function( event )
return e2d[ event ].sync.config.target ..
cutSlash( getPath( event ) )
end,
}
--
-- Retrievs event fields for the user script.
--
local eventMeta = {
__index = function( event, field )
local f = eventFields[ field ]
if not f then
if field == 'move' then
-- possibly undefined
return nil
end
error( 'event does not have field "'..field..'"', 2 )
end
return f( event )
end
}
--
-- Interface for user scripts to get list fields.
--
local eventListFuncs = {
--
-- Returns a list of paths of all events in list.
--
-- @param elist -- handle returned by getevents()
-- @param mutator -- if not nil called with (etype, path, path2)
-- returns one or two strings to add.
--
getPaths = function( elist, mutator )
local dlist = e2d[elist]
if not dlist then
error( 'cannot find delay list from event list.' )
end
local result = { }
local resultn = 1
for k, d in ipairs( dlist ) do