author | Patrik Svestka <patrik.svestka@gmail.com> |
Tue, 09 Apr 2019 11:34:04 +0200 | |
branch | jv |
changeset 24093 | 0f94f6c8c9d4 |
parent 21292 | 21faad473411 |
permissions | -rw-r--r-- |
10847 | 1 |
" |
2 |
COPYRIGHT (c) 2007 by eXept Software AG |
|
3 |
All Rights Reserved |
|
4 |
||
5 |
This software is furnished under a license and may be used |
|
6 |
only in accordance with the terms of that license and with the |
|
7 |
inclusion of the above copyright notice. This software may not |
|
8 |
be provided or otherwise made available to, or used by, any |
|
9 |
other person. No title to or ownership of the software is |
|
10 |
hereby transferred. |
|
11 |
" |
|
10761 | 12 |
"{ Package: 'stx:libbasic' }" |
13 |
||
18632 | 14 |
"{ NameSpace: Smalltalk }" |
15 |
||
10761 | 16 |
Filename subclass:#AutoDeletedFilename |
17 |
instanceVariableNames:'' |
|
18632 | 18 |
classVariableNames:'Lobby' |
10761 | 19 |
poolDictionaries:'' |
20 |
category:'System-Support' |
|
21 |
! |
|
22 |
||
23 |
!AutoDeletedFilename class methodsFor:'documentation'! |
|
24 |
||
10847 | 25 |
copyright |
26 |
" |
|
27 |
COPYRIGHT (c) 2007 by eXept Software AG |
|
28 |
All Rights Reserved |
|
29 |
||
30 |
This software is furnished under a license and may be used |
|
31 |
only in accordance with the terms of that license and with the |
|
32 |
inclusion of the above copyright notice. This software may not |
|
33 |
be provided or otherwise made available to, or used by, any |
|
34 |
other person. No title to or ownership of the software is |
|
35 |
hereby transferred. |
|
36 |
" |
|
37 |
! |
|
38 |
||
10761 | 39 |
documentation |
40 |
" |
|
41 |
Used with temporary files - these will automatically delete themself, |
|
21277 | 42 |
when no longer referenced (i.e. when finalized) |
43 |
||
10761 | 44 |
See -> Filename asAutoDeletedFilename |
21277 | 45 |
|
46 |
[author:] |
|
47 |
cg - original code |
|
48 |
sv - fixed and enhanced |
|
10761 | 49 |
" |
50 |
! |
|
51 |
||
52 |
examples |
|
53 |
" |
|
54 |
the following file will be automatically deleted after some time: |
|
10931
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
55 |
[exBegin] |
10761 | 56 |
|f p| |
57 |
||
15247 | 58 |
f := AutoDeletedFilename newTemporary. |
10761 | 59 |
f writeStream |
60 |
nextPutLine:'hello'; |
|
61 |
close. |
|
62 |
p := f pathName. |
|
63 |
Transcript showCR:p. |
|
64 |
f := f asAutoDeletedFilename. |
|
65 |
self assert:(p asFilename exists). |
|
66 |
ObjectMemory collectGarbage. |
|
67 |
Delay waitForSeconds:2. |
|
68 |
self assert:(p asFilename exists). |
|
69 |
f := nil. |
|
70 |
ObjectMemory collectGarbage. |
|
71 |
Delay waitForSeconds:2. |
|
72 |
self assert:(p asFilename exists not). |
|
10931
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
73 |
[exEnd] |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
74 |
|
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
75 |
|
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
76 |
you can also delete it manually: |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
77 |
[exBegin] |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
78 |
|f p| |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
79 |
|
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
80 |
f := Filename newTemporary. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
81 |
f writeStream |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
82 |
nextPutLine:'hello'; |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
83 |
close. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
84 |
p := f pathName. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
85 |
Transcript showCR:p. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
86 |
f := f asAutoDeletedFilename. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
87 |
self assert:(p asFilename exists). |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
88 |
ObjectMemory collectGarbage. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
89 |
Delay waitForSeconds:2. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
90 |
self assert:(p asFilename exists). |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
91 |
f remove. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
92 |
f := nil. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
93 |
ObjectMemory collectGarbage. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
94 |
Delay waitForSeconds:2. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
95 |
self assert:(p asFilename exists not). |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
96 |
[exEnd] |
10761 | 97 |
" |
98 |
! ! |
|
99 |
||
18632 | 100 |
!AutoDeletedFilename class methodsFor:'initialization'! |
101 |
||
102 |
initialize |
|
103 |
Lobby isNil ifTrue:[ |
|
104 |
Lobby := Registry new. |
|
105 |
]. |
|
106 |
Smalltalk addDependent:self. "inform me when smalltalk exits" |
|
107 |
! ! |
|
108 |
||
109 |
!AutoDeletedFilename class methodsFor:'change and update'! |
|
110 |
||
111 |
update:anAspect with:aParameter from:changedObject |
|
112 |
"when Smalltalk exits, remove all auto deleted files" |
|
113 |
||
114 |
anAspect == #aboutToQuit ifTrue:[ |
|
115 |
|currentFilename| |
|
116 |
"do it with timeout in case of a non-responding remote file server" |
|
117 |
([ |
|
118 |
Lobby do:[:each| |
|
119 |
currentFilename := each. |
|
120 |
each basicFinalize |
|
121 |
]. |
|
122 |
] valueWithTimeout:1 minutes) isNil ifTrue:[ |
|
123 |
'AutoDeletedFilename: timed out while removing: ' errorPrint. currentFilename errorPrintCR. |
|
124 |
]. |
|
125 |
]. |
|
18634 | 126 |
super update:anAspect with:aParameter from:changedObject |
18632 | 127 |
! ! |
128 |
||
10761 | 129 |
!AutoDeletedFilename methodsFor:'accessing'! |
130 |
||
15470 | 131 |
keep |
132 |
"do not delete the file on finalization" |
|
133 |
||
134 |
self unregisterForFinalization |
|
135 |
! |
|
136 |
||
137 |
setName:aString |
|
138 |
super setName:aString. |
|
139 |
self registerForFinalization |
|
140 |
! ! |
|
141 |
||
142 |
!AutoDeletedFilename methodsFor:'copying'! |
|
143 |
||
144 |
shallowCopy |
|
145 |
"when copying, return a real filename |
|
146 |
(to avoid mutiple removals)" |
|
147 |
||
15810 | 148 |
^ self species named:nameString |
15470 | 149 |
|
150 |
" |
|
151 |
'blaFaselQall.mist' asFilename asAutoDeletedFilename copy |
|
152 |
" |
|
153 |
! ! |
|
154 |
||
155 |
!AutoDeletedFilename methodsFor:'finalization'! |
|
156 |
||
18632 | 157 |
basicFinalize |
158 |
|linkInfo| |
|
159 |
||
160 |
linkInfo := self linkInfo. |
|
161 |
linkInfo notNil ifTrue:[ |
|
162 |
linkInfo isDirectory ifTrue:[ |
|
163 |
super recursiveRemove |
|
164 |
] ifFalse:[ |
|
165 |
super removeFile. |
|
166 |
]. |
|
167 |
]. |
|
168 |
! |
|
169 |
||
15470 | 170 |
executor |
171 |
^ self class basicNew nameString:nameString |
|
172 |
! |
|
173 |
||
18632 | 174 |
finalizationLobby |
175 |
"answer the registry used for finalization. |
|
176 |
we have our own Lobby." |
|
177 |
||
178 |
^ Lobby |
|
179 |
! |
|
180 |
||
10761 | 181 |
finalize |
16550 | 182 |
"/ do this in a forked process to avoid blocking |
183 |
"/ in case of an autodeleted remote file of a broken connection |
|
184 |
[ |
|
185 |
"/ with timeout to avoid waiting forever |
|
186 |
[ |
|
18632 | 187 |
self basicFinalize. |
16550 | 188 |
] valueWithTimeout:1 minutes. |
189 |
] fork. |
|
10761 | 190 |
! ! |
191 |
||
15810 | 192 |
!AutoDeletedFilename methodsFor:'queries'! |
193 |
||
194 |
species |
|
195 |
"filenames derived from me should not be autodeleted themself" |
|
196 |
||
197 |
^ Filename concreteClass. |
|
198 |
! ! |
|
199 |
||
10931
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
200 |
!AutoDeletedFilename methodsFor:'removing'! |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
201 |
|
11780
f7543590f82a
recursive remove directories when finalizing
Stefan Vogel <sv@exept.de>
parents:
10931
diff
changeset
|
202 |
recursiveRemove |
f7543590f82a
recursive remove directories when finalizing
Stefan Vogel <sv@exept.de>
parents:
10931
diff
changeset
|
203 |
super recursiveRemove. |
f7543590f82a
recursive remove directories when finalizing
Stefan Vogel <sv@exept.de>
parents:
10931
diff
changeset
|
204 |
self unregisterForFinalization |
f7543590f82a
recursive remove directories when finalizing
Stefan Vogel <sv@exept.de>
parents:
10931
diff
changeset
|
205 |
! |
f7543590f82a
recursive remove directories when finalizing
Stefan Vogel <sv@exept.de>
parents:
10931
diff
changeset
|
206 |
|
10931
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
207 |
remove |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
208 |
super remove. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
209 |
self unregisterForFinalization |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
210 |
! |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
211 |
|
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
212 |
removeDirectory |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
213 |
super removeDirectory. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
214 |
self unregisterForFinalization |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
215 |
! |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
216 |
|
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
217 |
removeFile |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
218 |
super removeFile. |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
219 |
self unregisterForFinalization |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
220 |
! ! |
54107ed355be
unregister from finalizatioin when deleting explicitly
Stefan Vogel <sv@exept.de>
parents:
10847
diff
changeset
|
221 |
|
10761 | 222 |
!AutoDeletedFilename class methodsFor:'documentation'! |
223 |
||
224 |
version |
|
18632 | 225 |
^ '$Header$' |
18634 | 226 |
! |
227 |
||
228 |
version_CVS |
|
229 |
^ '$Header$' |
|
10761 | 230 |
! ! |
15247 | 231 |
|
18632 | 232 |
|
233 |
AutoDeletedFilename initialize! |