-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfeatures.file-upload.html
543 lines (541 loc) · 10.2 KB
/
features.file-upload.html
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
<HTML
><HEAD
><TITLE
>Handling file uploads</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="Features"
HREF="features.html"><LINK
REL="PREVIOUS"
TITLE="Cookies"
HREF="features.cookies.html"><LINK
REL="NEXT"
TITLE="Common Pitfalls"
HREF="features.file-upload.common-pitfalls.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="chapter"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="features.cookies.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="features.file-upload.common-pitfalls.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="chapter"
><H1
><A
NAME="features.file-upload"
>Chapter 19. Handling file uploads</A
></H1
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="features.file-upload.html#features.file-upload.post-method"
>POST method uploads</A
></DT
><DT
><A
HREF="features.file-upload.common-pitfalls.html"
>Common Pitfalls</A
></DT
><DT
><A
HREF="feature-fileupload.multiple.html"
>Uploading multiple files</A
></DT
><DT
><A
HREF="features.file-upload.put-method.html"
>PUT method support</A
></DT
></DL
></DIV
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="features.file-upload.post-method"
>POST method uploads</A
></H1
><P
> PHP is capable of receiving file uploads from any RFC-1867
compliant browser (which includes Netscape Navigator 3 or later,
Microsoft Internet Explorer 3 with a patch from Microsoft, or
later without a patch). This feature lets people upload both text
and binary files. With PHP's authentication and file manipulation
functions, you have full control over who is allowed to upload and
what is to be done with the file once it has been uploaded.
</P
><P
> Note that PHP also supports PUT-method file uploads as used by
Netscape Composer and W3C's Amaya clients. See the <A
HREF="features.file-upload.put-method.html"
>PUT Method
Support</A
> for more details.
</P
><P
> A file upload screen can be built by creating a special form which
looks something like this:
<TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN4137"
></A
><P
><B
>Example 19-1. File Upload Form</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
> <FORM ENCTYPE="multipart/form-data" ACTION="_URL_" METHOD=POST>
<INPUT TYPE="hidden" name="MAX_FILE_SIZE" value="1000">
Send this file: <INPUT NAME="userfile" TYPE="file">
<INPUT TYPE="submit" VALUE="Send File">
</FORM>
</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
The _URL_ should point to a PHP file. The MAX_FILE_SIZE hidden
field must precede the file input field and its value is the
maximum filesize accepted. The value is in bytes.
</P
><P
> In PHP 3, the following variables will be defined within the
destination script upon a successful upload, assuming that <A
HREF="configuration.html#ini.register-globals"
>register_globals</A
> is turned
on in <TT
CLASS="filename"
>php.ini</TT
>. If <A
HREF="configuration.html#ini.track-vars"
>track_vars</A
> is turned on, they will
also be available within the global array
<TT
CLASS="varname"
>$HTTP_POST_VARS</TT
>. Note that the following
variable names assume the use of the file upload name 'userfile',
as used in the example above:
<P
></P
><UL
><LI
><P
> <TT
CLASS="varname"
>$userfile</TT
> - The temporary filename in which
the uploaded file was stored on the server machine.
</P
></LI
><LI
><P
> <TT
CLASS="varname"
>$userfile_name</TT
> - The original name or path
of the file on the sender's system.
</P
></LI
><LI
><P
> <TT
CLASS="varname"
>$userfile_size</TT
> - The size of the uploaded
file in bytes.
</P
></LI
><LI
><P
> <TT
CLASS="varname"
>$userfile_type</TT
> - The mime type of the file
if the browser provided this information. An example would be
"image/gif".
</P
></LI
></UL
>
Note that the "$userfile" part of the above variables is
whatever the name of the INPUT field of TYPE=file is in the upload
form. In the above upload form example, we chose to call it
"userfile"
</P
><P
> In PHP 4, the behaviour is slightly different, in that the new
global array <TT
CLASS="varname"
>$HTTP_POST_FILES</TT
> is provided to
contain the uploaded file information. This is still only
available if <A
HREF="configuration.html#ini.track-vars"
>track_vars</A
> is
turned on, but <A
HREF="configuration.html#ini.track-vars"
>track_vars</A
> is
always turned on in versions of PHP after PHP 4.0.2.
</P
><P
> The contents of <TT
CLASS="varname"
>$HTTP_POST_FILES</TT
> are as
follows. Note that this assumes the use of the file upload name
'userfile', as used in the example above:
<P
></P
><DIV
CLASS="variablelist"
><DL
><DT
><TT
CLASS="varname"
>$HTTP_POST_FILES['userfile']['name']</TT
></DT
><DD
><P
> The original name of the file on the client machine.
</P
></DD
><DT
><TT
CLASS="varname"
>$HTTP_POST_FILES['userfile']['type']</TT
></DT
><DD
><P
> The mime type of the file, if the browser provided this
information. An example would be
<TT
CLASS="literal"
>"image/gif"</TT
>.
</P
></DD
><DT
><TT
CLASS="varname"
>$HTTP_POST_FILES['userfile']['size']</TT
></DT
><DD
><P
> The size, in bytes, of the uploaded file.
</P
></DD
><DT
><TT
CLASS="varname"
>$HTTP_POST_FILES['userfile']['tmp_name']</TT
></DT
><DD
><P
> The temporary filename of the file in which the uploaded file
was stored on the server.
</P
></DD
></DL
></DIV
>
</P
><P
> Files will by default be stored in the server's default temporary
directory, unless another location has been given with the <A
HREF="configuration.html#ini.upload-tmp-dir"
>upload_tmp_dir</A
> directive in
<TT
CLASS="filename"
>php.ini</TT
>. The server's default directory can
be changed by setting the environment variable
<TT
CLASS="envar"
>TMPDIR</TT
> in the environment in which PHP runs.
Setting it using <A
HREF="function.putenv.html"
><B
CLASS="function"
>putenv()</B
></A
> from within a PHP
script will not work. This environment variable can also be used
to make sure that other operations are working on uploaded files,
as well.
<TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN4191"
></A
><P
><B
>Example 19-2. Validating file uploads</B
></P
><P
> The following examples are for versions of PHP 3 greater than
3.0.16, and versions of PHP 4 greater than 4.0.2. See the
function entries for <A
HREF="function.is-uploaded-file.html"
><B
CLASS="function"
>is_uploaded_file()</B
></A
> and
<A
HREF="function.move-uploaded-file.html"
><B
CLASS="function"
>move_uploaded_file()</B
></A
>.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
> <?php
if (is_uploaded_file($userfile)) {
copy($userfile, "/place/to/put/uploaded/file");
} else {
echo "Possible file upload attack: filename '$userfile'.";
}
/* ...or... */
move_uploaded_file($userfile, "/place/to/put/uploaded/file");
?>
</PRE
></TD
></TR
></TABLE
><P
> For earlier versions of PHP, you'll need to do something like
the following.
<DIV
CLASS="note"
><BLOCKQUOTE
CLASS="note"
><P
><B
>Note: </B
>
This will <I
CLASS="emphasis"
>not</I
> work in versions of PHP 4
after 4.0.2. It depends on internal functionality of PHP which
changed after that version.
</P
></BLOCKQUOTE
></DIV
>
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
> <?php
/* Userland test for uploaded file. */
function is_uploaded_file($filename) {
if (!$tmp_file = get_cfg_var('upload_tmp_dir')) {
$tmp_file = dirname(tempnam('', ''));
}
$tmp_file .= '/' . basename($filename);
/* User might have trailing slash in php.ini... */
return (ereg_replace('/+', '/', $tmp_file) == $filename);
}
if (is_uploaded_file($userfile)) {
copy($userfile, "/place/to/put/uploaded/file");
} else {
echo "Possible file upload attack: filename '$userfile'.";
}
?>
</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
</P
><P
> The PHP script which receives the uploaded file should implement
whatever logic is necessary for determining what should be done
with the uploaded file. You can for example use the
<TT
CLASS="varname"
>$file_size</TT
> variable to throw away any files
that are either too small or too big. You could use the
<TT
CLASS="varname"
>$file_type</TT
> variable to throw away any files
that didn't match a certain type criteria. Whatever the logic,
you should either delete the file from the temporary directory or
move it elsewhere.
</P
><P
> The file will be deleted from the temporary directory at the end
of the request if it has not been moved away or renamed.
</P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="features.cookies.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="features.file-upload.common-pitfalls.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Cookies</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="features.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Common Pitfalls</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>