/
Files.nim
578 lines (523 loc) · 22.8 KB
/
Files.nim
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
#=======================================================
# Arturo
# Programming Language + Bytecode VM compiler
# (c) 2019-2023 Yanis Zafirópulos
#
# @file: library/Files.nim
#=======================================================
## The main Files module
## (part of the standard library)
#=======================================
# Pragmas
#=======================================
{.used.}
#=======================================
# Libraries
#=======================================
when not defined(WEB):
import os, sequtils, sugar, times
import extras/miniz
when not defined(NOPARSERS):
import helpers/html
import helpers/markdown
import helpers/toml
import helpers/xml
import helpers/csv
import helpers/datasource
import helpers/io
import helpers/jsonobject
import vm/lib
when not defined(WEB):
import vm/[bytecode, errors, parse]
#=======================================
# Methods
#=======================================
proc defineSymbols*() =
# TODO(Files) more potential built-in function candidates?
# labels: library, enhancement, open discussion
when not defined(WEB):
builtin "copy",
alias = unaliased,
op = opNop,
rule = PrefixPrecedence,
description = "copy file at path to given destination",
args = {
"file" : {String},
"destination" : {String}
},
attrs = {
"directory" : ({Logical},"path is a directory")
},
returns = {Nothing},
example = """
copy "testscript.art" normalize.tilde "~/Desktop/testscript.art"
; copied file
..........
copy "testfolder" normalize.tilde "~/Desktop/testfolder"
; copied whole folder
""":
#=======================================================
when defined(SAFE): RuntimeError_OperationNotPermitted("copy")
var target = y.s
if (hadAttr("directory")):
try:
copyDirWithPermissions(x.s, move target)
except OSError:
discard
else:
try:
copyFileWithPermissions(x.s, move target)
except OSError:
discard
builtin "delete",
alias = unaliased,
op = opNop,
rule = PrefixPrecedence,
description = "delete file at given path",
args = {
"file" : {String}
},
attrs = {
"directory" : ({Logical},"path is a directory")
},
returns = {Nothing},
example = """
delete "testscript.art"
; file deleted
""":
#=======================================================
when defined(SAFE): RuntimeError_OperationNotPermitted("delete")
if (hadAttr("directory")):
try:
removeDir(x.s)
except OSError:
discard
else:
discard tryRemoveFile(x.s)
builtin "exists?",
alias = unaliased,
op = opNop,
rule = PrefixPrecedence,
description = "check if given file exists",
args = {
"file" : {String}
},
attrs = {
"directory" : ({Logical},"check for directory")
},
returns = {Logical},
example = """
if exists? "somefile.txt" [
print "file exists!"
]
""":
#=======================================================
when defined(SAFE): RuntimeError_OperationNotPermitted("exists?")
if (hadAttr("directory")):
push(newLogical(dirExists(x.s)))
else:
push(newLogical(fileExists(x.s)))
builtin "hidden?",
alias = unaliased,
op = opNop,
rule = PrefixPrecedence,
description = "check if file/folder at given path is hidden",
args = {
"file" : {String}
},
attrs = NoAttrs,
returns = {Logical},
example = """
hidden? "README.md" ; => false
hidden? ".git" ; => true
""":
#=======================================================
when defined(SAFE): RuntimeError_OperationNotPermitted("hidden?")
push newLogical(isHidden(x.s))
builtin "move",
alias = unaliased,
op = opNop,
rule = PrefixPrecedence,
description = "move file at path to given destination",
args = {
"file" : {String},
"destination" : {String}
},
attrs = {
"directory" : ({Logical},"path is a directory")
},
returns = {Nothing},
example = """
move "testscript.art" normalize.tilde "~/Desktop/testscript.art"
; moved file
..........
move "testfolder" normalize.tilde "~/Desktop/testfolder"
; moved whole folder
""":
#=======================================================
when defined(SAFE): RuntimeError_OperationNotPermitted("move")
var target = y.s
if (hadAttr("directory")):
try:
moveDir(x.s, move target)
except OSError:
discard
else:
try:
moveFile(x.s, move target)
except OSError:
discard
builtin "permissions",
alias = unaliased,
op = opNop,
rule = PrefixPrecedence,
description = "check permissions of given file",
args = {
"file" : {String}
},
attrs = {
"set" : ({Dictionary},"set using given file permissions")
},
returns = {Dictionary,Null},
example = """
inspect permissions "bin/arturo"
; [ :dictionary
; user : [ :dictionary
; read : true :boolean
; write : true :boolean
; execute : true :boolean
; ]
; group : [ :dictionary
; read : true :boolean
; write : false :boolean
; execute : true :boolean
; ]
; others : [ :dictionary
; read : true :boolean
; write : false :boolean
; execute : true :boolean
; ]
; ]
..........
permissions.set:#[others:#[write:true]] "bin/arturo"
; gave write permission to 'others'
""":
#=======================================================
when defined(SAFE): RuntimeError_OperationNotPermitted("permissions")
try:
if (hadAttr("set")):
var source = x.s
var perms: set[FilePermission]
if x.d.hasKey("user") and x.d["user"].d.hasKey("read"): perms.incl(fpUserRead)
if x.d.hasKey("user") and x.d["user"].d.hasKey("write"): perms.incl(fpUserWrite)
if x.d.hasKey("user") and x.d["user"].d.hasKey("execute"): perms.incl(fpUserExec)
if x.d.hasKey("group") and x.d["group"].d.hasKey("read"): perms.incl(fpGroupRead)
if x.d.hasKey("group") and x.d["group"].d.hasKey("write"): perms.incl(fpGroupWrite)
if x.d.hasKey("group") and x.d["group"].d.hasKey("execute"): perms.incl(fpGroupExec)
if x.d.hasKey("others") and x.d["others"].d.hasKey("read"): perms.incl(fpOthersRead)
if x.d.hasKey("others") and x.d["others"].d.hasKey("write"): perms.incl(fpOthersWrite)
if x.d.hasKey("others") and x.d["others"].d.hasKey("execute"): perms.incl(fpOthersExec)
setFilePermissions(move source, move perms)
else:
let perms = getFilePermissions(x.s)
var permsDict: ValueDict = {
"user": newDictionary({
"read" : newLogical(fpUserRead in perms),
"write" : newLogical(fpUserWrite in perms),
"execute" : newLogical(fpUserExec in perms)
}.toOrderedTable),
"group": newDictionary({
"read" : newLogical(fpGroupRead in perms),
"write" : newLogical(fpGroupWrite in perms),
"execute" : newLogical(fpGroupExec in perms)
}.toOrderedTable),
"others": newDictionary({
"read" : newLogical(fpOthersRead in perms),
"write" : newLogical(fpOthersWrite in perms),
"execute" : newLogical(fpOthersExec in perms)
}.toOrderedTable)
}.toOrderedTable
push(newDictionary(permsDict))
except OSError:
push(VNULL)
builtin "read",
alias = doublearrowleft,
op = opNop,
rule = PrefixPrecedence,
description = "read file from given path",
args = {
"file" : {String}
},
attrs =
when not defined(NOPARSERS):
{
"lines" : ({Logical},"read file lines into block"),
"json" : ({Logical},"read Json into value"),
"csv" : ({Logical},"read CSV file into a block of rows"),
"withHeaders" : ({Logical},"read CSV headers"),
"html" : ({Logical},"read HTML into node dictionary"),
"xml" : ({Logical},"read XML into node dictionary"),
"markdown" : ({Logical},"read Markdown and convert to HTML"),
"toml" : ({Logical},"read TOML into value"),
"bytecode" : ({Logical},"read file as Arturo bytecode"),
"binary" : ({Logical},"read as binary"),
"file" : ({Logical},"read as file (throws an error if not valid)")
}
else:
{
"lines" : ({Logical},"read file lines into block"),
"json" : ({Logical},"read Json into value"),
"csv" : ({Logical},"read CSV file into a block of rows"),
"withHeaders" : ({Logical},"read CSV headers"),
"bytecode" : ({Logical},"read file as Arturo bytecode"),
"binary" : ({Logical},"read as binary"),
"file" : ({Logical},"read as file (throws an error if not valid)")
},
returns = {String,Block,Binary},
example = """
; reading a simple local file
str: read "somefile.txt"
..........
; also works with remote urls
page: read "http://www.somewebsite.com/page.html"
..........
; we can also "read" JSON data as an object
data: read.json "mydata.json"
..........
; or even convert Markdown to HTML on-the-fly
html: read.markdown "## Hello" ; "<h2>Hello</h2>"
""":
#=======================================================
if (hadAttr("binary")):
var f: File
discard f.open(x.s)
var b: seq[byte] = newSeq[byte](f.getFileSize())
discard f.readBytes(b, 0, f.getFileSize())
f.close()
push(newBinary(b))
else:
let (src, tp) = getSource(x.s)
if (hadAttr("file") and tp != FileData):
RuntimeError_FileNotFound(src)
if (hadAttr("lines")):
push(newStringBlock(src.splitLines()))
elif (hadAttr("json")):
push(valueFromJson(src))
elif (hadAttr("csv")):
push(parseCsvInput(src, withHeaders=(hadAttr("withHeaders"))))
elif (hadAttr("bytecode")):
let bcode = readBytecode(x.s)
let parsed = doParse(bcode[0], isFile=false).a[0]
push(newBytecode(Translation(constants: parsed.a, instructions: bcode[1])))
else:
when not defined(NOPARSERS):
if (hadAttr("toml")):
push(parseTomlString(src))
elif (hadAttr("markdown")):
push(parseMarkdownInput(src))
elif (hadAttr("html")):
push(parseHtmlInput(src))
elif (hadAttr("xml")):
push(parseXMLInput(src))
else:
push(newString(src))
else:
push(newString(src))
# elif attrs.hasKey("xml"):
# push(parseXmlNode(parseXml(action(x.s))))
builtin "rename",
alias = unaliased,
op = opNop,
rule = PrefixPrecedence,
description = "rename file at path using given new path name",
args = {
"file" : {String},
"name" : {String}
},
attrs = {
"directory" : ({Logical},"path is a directory")
},
returns = {Nothing},
example = """
rename "README.md" "READIT.md"
; file renamed
""":
#=======================================================
when defined(SAFE): RuntimeError_OperationNotPermitted("rename")
var source = x.s
var target = y.s
if (hadAttr("directory")):
try:
moveDir(move source, move target)
except OSError:
discard
else:
try:
moveFile(move source, move target)
except OSError:
discard
builtin "symlink",
alias = unaliased,
op = opNop,
rule = PrefixPrecedence,
description = "create symbolic link of file to given destination",
args = {
"file" : {String},
"destination" : {String}
},
attrs = {
"hard" : ({Logical},"create a hard link")
},
returns = {Nothing},
example = """
symlink relative "arturo/README.md"
"/Users/drkameleon/Desktop/gotoREADME.md"
; creates a symbolic link to our readme file
; in our desktop
..........
symlink.hard relative "arturo/README.md"
"/Users/drkameleon/Desktop/gotoREADME.md"
; hard-links (effectively copies) our readme file
; to our desktop
""":
#=======================================================
when defined(SAFE): RuntimeError_OperationNotPermitted("symlink")
var source = x.s
var target = y.s
try:
if (hadAttr("hard")):
createHardlink(move source, move target)
else:
createSymlink(move source, move target)
except OSError:
discard
builtin "timestamp",
alias = unaliased,
op = opNop,
rule = PrefixPrecedence,
description = "get file timestamps",
args = {
"file" : {String}
},
attrs = NoAttrs,
returns = {Dictionary,Null},
example = """
timestamp "README.md"
; => [created:2022-09-21T12:35:04+02:00 accessed:2022-09-21T12:35:04+02:00 modified:2022-09-21T12:35:04+02:00]
timestamp "some-file-that-does-not-exist.txt"
; => null
""":
#=======================================================
try:
push newDictionary({
"created": newDate(local(getCreationTime(x.s))),
"accessed": newDate(local(getLastAccessTime(x.s))),
"modified": newDate(local(getLastModificationTime(x.s)))
}.toOrderedTable)
except:
push VNULL
builtin "unzip",
alias = unaliased,
op = opNop,
rule = PrefixPrecedence,
description = "unzip given archive to destination",
args = {
"destination" : {String},
"original" : {String}
},
attrs = NoAttrs,
returns = {Nothing},
example = """
unzip "folder" "archive.zip"
""":
#=======================================================
when defined(SAFE): RuntimeError_OperationNotPermitted("unzip")
miniz.unzip(y.s, x.s)
builtin "volume",
alias = unaliased,
op = opNop,
rule = PrefixPrecedence,
description = "get file size for given path",
args = {
"file" : {String}
},
attrs = NoAttrs,
returns = {Quantity},
example = """
volume "README.md"
; => 13704B
; (size in bytes)
""":
#=======================================================
when defined(SAFE): RuntimeError_OperationNotPermitted("volume")
push newQuantity(newInteger(getFileSize(x.s)), newQuantitySpec(B))
builtin "write",
alias = doublearrowright,
op = opNop,
rule = PrefixPrecedence,
description = "write content to file at given path",
args = {
"file" : {String,Null},
"content" : {Any}
},
attrs = {
"append" : ({Logical},"append to given file"),
"directory" : ({Logical},"create directory at path"),
"json" : ({Logical},"write value as Json"),
"compact" : ({Logical},"produce compact, non-prettified Json code"),
"binary" : ({Logical},"write as binary")
},
returns = {Nothing},
example = """
; write some string data to given file path
write "somefile.txt" "Hello world!"
..........
; we can also write any type of data as JSON
write.json "data.json" myData
..........
; append to an existing file
write.append "somefile.txt" "Yes, Hello again!"
""":
#=======================================================
when defined(SAFE): RuntimeError_OperationNotPermitted("write")
if y.kind==Bytecode:
let dataS = codify(newBlock(y.trans.constants), unwrapped=true, safeStrings=true)
let codeS = y.trans.instructions
discard writeBytecode(dataS, codeS, x.s)
else:
if (hadAttr("directory")):
createDir(x.s)
else:
if (hadAttr("binary")):
writeToFile(x.s, y.n, append = (hadAttr("append")))
else:
if (hadAttr("json")):
let rez = jsonFromValue(y, pretty=(not hadAttr("compact")))
if x.kind==String:
writeToFile(x.s, rez, append = (hadAttr("append")))
else:
push(newString(rez))
else:
writeToFile(x.s, y.s, append = (hadAttr("append")))
builtin "zip",
alias = unaliased,
op = opNop,
rule = PrefixPrecedence,
description = "zip given files to file at destination",
args = {
"destination" : {String},
"files" : {Block}
},
attrs = NoAttrs,
returns = {Nothing},
example = """
zip "dest.zip" ["file1.txt" "img.png"]
""":
#=======================================================
when defined(SAFE): RuntimeError_OperationNotPermitted("zip")
let files: seq[string] = y.a.map((z)=>z.s)
miniz.zip(files, x.s)
#=======================================
# Add Library
#=======================================
Libraries.add(defineSymbols)