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
|
#
#
# Nim's Runtime Library
# (c) Copyright 2021 Nim contributors
#
# See the file "copying.txt", included in this
# distribution, for details about the copyright.
#
## This module creates temporary files and directories.
##
## Experimental API, subject to change.
import os, random
const
maxRetry = 10000
letters = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
nimTempPathLength {.intdefine.} = 8
when defined(windows):
import winlean
var O_RDWR {.importc: "_O_RDWR", header: "<fcntl.h>".}: cint
proc c_fdopen(
filehandle: cint,
mode: cstring
): File {.importc: "_fdopen",header: "<stdio.h>".}
proc open_osfhandle(osh: Handle, mode: cint): cint {.
importc: "_open_osfhandle", header: "<io.h>".}
proc close_osfandle(fd: cint): cint {.
importc: "_close", header: "<io.h>".}
else:
import posix
proc c_fdopen(
filehandle: cint,
mode: cstring
): File {.importc: "fdopen",header: "<stdio.h>".}
proc safeOpen(filename: string): File =
## Open files exclusively.
# xxx this should be clarified; it doesn't in particular prevent other processes
# from opening the file, at least currently.
when defined(windows):
let dwShareMode = FILE_SHARE_DELETE or FILE_SHARE_READ or FILE_SHARE_WRITE
let dwCreation = CREATE_NEW
let dwFlags = FILE_FLAG_BACKUP_SEMANTICS or FILE_ATTRIBUTE_NORMAL
let handle = createFileW(newWideCString(filename), GENERIC_READ or GENERIC_WRITE, dwShareMode,
nil, dwCreation, dwFlags, Handle(0))
if handle == INVALID_HANDLE_VALUE:
raiseOSError(osLastError(), filename)
let fileHandle = open_osfhandle(handle, O_RDWR)
if fileHandle == -1:
discard closeHandle(handle)
raiseOSError(osLastError(), filename)
result = c_fdopen(fileHandle, "w+")
if result == nil:
discard close_osfandle(fileHandle)
raiseOSError(osLastError(), filename)
else:
# xxx we need a `proc toMode(a: FilePermission): Mode`, possibly by
# exposing fusion/filepermissions.fromFilePermissions to stdlib; then we need
# to expose a `perm` param so users can customize this (e.g. the temp file may
# need execute permissions), and figure out how to make the API cross platform.
let mode = Mode(S_IRUSR or S_IWUSR)
let flags = posix.O_RDWR or posix.O_CREAT or posix.O_EXCL
let fileHandle = posix.open(filename, flags, mode)
if fileHandle == -1:
raiseOSError(osLastError(), filename)
result = c_fdopen(fileHandle, "w+")
if result == nil:
discard posix.close(fileHandle) # TODO handles failure when closing file
raiseOSError(osLastError(), filename)
template randomPathName(length: Natural): string =
var res = newString(length)
var state = initRand()
for i in 0 ..< length:
res[i] = state.sample(letters)
res
proc getTempDirImpl(dir: string): string {.inline.} =
result = dir
if result.len == 0:
result = getTempDir()
proc genTempPath*(prefix, suffix: string, dir = ""): string =
## Generates a path name in `dir`.
##
## If `dir` is empty, (`getTempDir <os.html#getTempDir>`_) will be used.
## The path begins with `prefix` and ends with `suffix`.
let dir = getTempDirImpl(dir)
result = dir / (prefix & randomPathName(nimTempPathLength) & suffix)
proc createTempFile*(prefix, suffix: string, dir = ""): tuple[fd: File, path: string] =
## Creates a new temporary file in the directory `dir`.
##
## This generates a path name using `genTempPath(prefix, suffix, dir)` and
## returns a file handle to an open file and the path of that file, possibly after
## retrying to ensure it doesn't already exist.
##
## If failing to create a temporary file, `IOError` will be raised.
##
## .. note:: It is the caller's responsibility to remove the file when no longer needed.
let dir = getTempDirImpl(dir)
createDir(dir)
for i in 0 ..< maxRetry:
result.path = genTempPath(prefix, suffix, dir)
try:
result.fd = safeOpen(result.path)
except OSError:
continue
return
raise newException(IOError, "Failed to create a temporary file under directory " & dir)
proc createTempDir*(prefix, suffix: string, dir = ""): string =
## Creates a new temporary directory in the directory `dir`.
##
## This generates a dir name using `genTempPath(prefix, suffix, dir)`, creates
## the directory and returns it, possibly after retrying to ensure it doesn't
## already exist.
##
## If failing to create a temporary directory, `IOError` will be raised.
##
## .. note:: It is the caller's responsibility to remove the directory when no longer needed.
let dir = getTempDirImpl(dir)
createDir(dir)
for i in 0 ..< maxRetry:
result = genTempPath(prefix, suffix, dir)
try:
if not existsOrCreateDir(result):
return
except OSError:
continue
raise newException(IOError, "Failed to create a temporary directory under directory " & dir)
|