blob: 8266e4201e212170e1921b68b9d278b4641cbf03 (
plain)
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
|
<?php
/**
* Location holder of files stored temporarily
*
* 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 2 of the License, 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 this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup FileBackend
*/
/**
* This class is used to hold the location and do limited manipulation
* of files stored temporarily (this will be whatever wfTempDir() returns)
*
* @ingroup FileBackend
*/
class TempFSFile extends FSFile {
protected $canDelete = false; // bool; garbage collect the temp file
/** @var Array of active temp files to purge on shutdown */
protected static $instances = array();
/**
* Make a new temporary file on the file system.
* Temporary files may be purged when the file object falls out of scope.
*
* @param string $prefix
* @param string $extension
* @return TempFSFile|null
*/
public static function factory( $prefix, $extension = '' ) {
wfProfileIn( __METHOD__ );
$base = wfTempDir() . '/' . $prefix . wfRandomString( 12 );
$ext = ( $extension != '' ) ? ".{$extension}" : "";
for ( $attempt = 1; true; $attempt++ ) {
$path = "{$base}-{$attempt}{$ext}";
wfSuppressWarnings();
$newFileHandle = fopen( $path, 'x' );
wfRestoreWarnings();
if ( $newFileHandle ) {
fclose( $newFileHandle );
break; // got it
}
if ( $attempt >= 5 ) {
wfProfileOut( __METHOD__ );
return null; // give up
}
}
$tmpFile = new self( $path );
$tmpFile->canDelete = true; // safely instantiated
wfProfileOut( __METHOD__ );
return $tmpFile;
}
/**
* Purge this file off the file system
*
* @return bool Success
*/
public function purge() {
$this->canDelete = false; // done
wfSuppressWarnings();
$ok = unlink( $this->path );
wfRestoreWarnings();
return $ok;
}
/**
* Clean up the temporary file only after an object goes out of scope
*
* @param Object $object
* @return TempFSFile This object
*/
public function bind( $object ) {
if ( is_object( $object ) ) {
if ( !isset( $object->tempFSFileReferences ) ) {
// Init first since $object might use __get() and return only a copy variable
$object->tempFSFileReferences = array();
}
$object->tempFSFileReferences[] = $this;
}
return $this;
}
/**
* Set flag to not clean up after the temporary file
*
* @return TempFSFile This object
*/
public function preserve() {
$this->canDelete = false;
return $this;
}
/**
* Set flag clean up after the temporary file
*
* @return TempFSFile This object
*/
public function autocollect() {
$this->canDelete = true;
return $this;
}
/**
* Cleans up after the temporary file by deleting it
*/
function __destruct() {
if ( $this->canDelete ) {
wfSuppressWarnings();
unlink( $this->path );
wfRestoreWarnings();
}
}
}
|
