-
Notifications
You must be signed in to change notification settings - Fork 444
/
FileWrapper.inc.php
172 lines (151 loc) · 3.89 KB
/
FileWrapper.inc.php
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
<?php
/**
* @defgroup file_wrapper File Wrappers
*/
/**
* @file classes/file/FileWrapper.inc.php
*
* Copyright (c) 2014-2020 Simon Fraser University
* Copyright (c) 2000-2020 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class FileWrapper
* @ingroup file
*
* @brief Class abstracting operations for reading remote files using various protocols.
* (for when allow_url_fopen is disabled).
*
* TODO:
* - Other protocols?
* - Write mode (where possible)
*/
class FileWrapper {
/** @var string URL to the file */
var $url;
/** @var array parsed URL info */
var $info;
/** @var resource The file descriptor */
var $fp = null;
/**
* Constructor.
* @param $url string
* @param $info array
*/
function __construct($url, $info) {
$this->url = $url;
$this->info = $info;
}
/**
* Read and return the contents of the file (like file_get_contents()).
* @return string
*/
function contents() {
$contents = '';
if ($retval = $this->open()) {
if (is_object($retval)) { // It may be a redirect
return $retval->contents();
}
while (!$this->eof())
$contents .= $this->read();
$this->close();
}
return $contents;
}
/**
* Open the file.
* @param $mode string only 'r' (read-only) is currently supported
* @return boolean
*/
function open($mode = 'r') {
$this->fp = null;
$this->fp = fopen($this->url, $mode);
return ($this->fp !== false);
}
/**
* Close the file.
*/
function close() {
fclose($this->fp);
unset($this->fp);
}
/**
* Save the file to the specified filename.
* @return int|false Number of bytes saved on success, or false on failure
*/
function save($filename) {
$targetFp = fopen($filename, 'w');
if (!$targetFp) return false;
$returner = stream_copy_to_stream($this->fp, $targetFp);
fclose($targetFp);
return $returner;
}
/**
* Read from the file.
* @param $len int
* @return string
*/
function read($len = 8192) {
return fread($this->fp, $len);
}
/**
* Check for end-of-file.
* @return boolean
*/
function eof() {
return feof($this->fp);
}
//
// Static
//
/**
* Return instance of a class for reading the specified URL.
* @param $source mixed; URL, filename, or resources
* @return FileWrapper
*/
static function wrapper($source) {
if (ini_get('allow_url_fopen') && Config::getVar('general', 'allow_url_fopen') && is_string($source)) {
$info = parse_url($source);
$wrapper = new FileWrapper($source, $info);
} elseif (is_resource($source)) {
// $source is an already-opened file descriptor.
import('lib.pkp.classes.file.wrappers.ResourceWrapper');
$wrapper = new ResourceWrapper($source);
} else {
// $source should be a URL.
$info = parse_url($source);
if (isset($info['scheme'])) {
$scheme = $info['scheme'];
} else {
$scheme = null;
}
$application = Application::get();
$request = $application->getRequest();
$router = $request->getRouter();
if (!Config::getVar('general', 'installed') || defined('RUNNING_UPGRADE') || !$router) {
$userAgent = $application->getName() . '/?';
} else {
$currentVersion =& $application->getCurrentVersion();
$userAgent = $application->getName() . '/' . $currentVersion->getVersionString();
}
switch ($scheme) {
case 'http':
import('lib.pkp.classes.file.wrappers.HTTPFileWrapper');
$wrapper = new HTTPFileWrapper($source, $info);
$wrapper->addHeader('User-Agent', $userAgent);
break;
case 'https':
import('lib.pkp.classes.file.wrappers.HTTPSFileWrapper');
$wrapper = new HTTPSFileWrapper($source, $info);
$wrapper->addHeader('User-Agent', $userAgent);
break;
case 'ftp':
import('lib.pkp.classes.file.wrappers.FTPFileWrapper');
$wrapper = new FTPFileWrapper($source, $info);
break;
default:
$wrapper = new FileWrapper($source, $info);
}
}
return $wrapper;
}
}