PHP檔案上傳原始碼分析(RFC1867)

檔案上傳,一般分為倆種方式FTP和HTTP, 對於我們的網際網路應用來說: FTP上傳雖然傳輸穩定, 但是易用性和安全性都是個問題. 你總不至於在使用者要上傳頭像的時候告訴使用者”請開啟FTP客戶端,上傳檔案到http://www.laruence.com/uploads/中, 並以2dk433423l.jpg命名”吧?

而基於HTTP的上傳,相對來說易用性和安全性上就比FTP要增強了很多. 可以應用的上傳方式有PUT, WEBDAV, 和RFC1867三種, 本文將分析在PHP中,是如何基於RFC1867實現檔案上傳的.

RFC1867

RCF1867是Form-based File Upload in HTML標準協議, RFC1867標準對HTML做出了兩處修改：
　

1 為input元素的type屬性增加了一個file選項。
2 input標記可以具有accept屬性，該屬效能夠指定可被上傳的檔案型別或檔案格式列表。

　　
另外，本標準還定義了一種新的mime型別：multipart/form-data，以及當處理一個帶有enctype=”multipart/form-data” 並且/或含有<input type=”file”>的標記的表單時所應該採取的行為。
　　
舉例來說，當HTML想讓使用者能夠上傳一個或更多的檔案時，他可以這麼寫：

<form enctype="multipart/form-data" action="upload.php" method=post>
選擇檔案:
<input name="userfile" type="file">
檔案描述:
<input name="description" type="text">
<input type="submit" value="上傳">
</form>

這個表單, 大家一定不陌生, 而對於PHP來說, 它自己另外定義了一個預設表單元素MAX_FILE_SIZE, 使用者可以通過這個隱藏的表單元素來建議PHP最多隻容許上傳檔案的大小, 比如對於上面的例子, 我們希望使用者上傳的檔案不能大於5000(5k)位元組, 那麼可以如下寫:

<form enctype="multipart/form-data" action="upload.php" method=post>
<input type="hidden" value="5000" name="MAX_FILE_SIZE"> <!--檔案大小-->
選擇檔案:
<input name="userfile" type="file">
檔案描述:
<input name="description" type="text">
<input type="submit" value="上傳">
</form>

姑且不說, 這個MAX_FILE_SIZE是多麼的不可靠(所以基於瀏覽器的控制,都是不可靠的), 單純從實現來講, 我會慢慢介紹這個MAX_FILE_SIZE是如何起作用的.

當使用者選擇了一個檔案(laruence.txt), 並填寫好檔案描述(”laruence的個人介紹”), 點選上傳後, 發生了什麼呢?

表單提交

在使用者確定提交以後, 瀏覽器會傳送如下類似格式的資料包到form中action屬性指定的頁面(在本例中是upload.php):

//請求頭
POST /upload.php HTTP/1.0/r/n
...
Host: www.laruence.com/r/n
...
Content-length: xxxxx/r/n
...
Content-type: multipart/form-data, boundary=--------------7d51863950254/r/n
.../r/n/r/n
//開始POST資料內容
---------------7d51863950254
content-disposition: form-data; name="description"
laruence的個人介紹
---------------7d51863950254
content-disposition: form-data; name="userfile"; filename="laruence.txt"
Content-Type: text/plain
... laruence.txt 的內容...
---------------7d51863950254

接下來, 就是伺服器, 是如何處理這些資料了.

接受上傳

當Web伺服器, 此處假設為Apache(另外假設PHP是以module方式安裝在Apache上的), 接受到使用者的資料時, 首先它根據HTTP請求頭, 通過確定MIME TYPE為PHP型別, 然後經過一些過程以後(這部分,可以參看我之前的PHP Life Cycle ppt), 最終會把控制權交給PHP模組.

這個時候, PHP會呼叫sapi_activate來初始化一個請求, 在這個過程中, 首先判斷請求型別, 此時是POST, 從而去呼叫sapi_read_post_data, 通過Content-type, 找到rfc1867的處理函式rfc1867_post_handler, 從而呼叫這個handler, 來分析POST來的資料.

關於rfc1867_post_handler這部分的原始碼, 可以在mian/rfc1867.c找到, 另外也可以參看我之前的深入理解PHP之檔案上傳, 其中也列出的原始碼.

然後, PHP通過boundary, 對於每一個分段, 都通過檢查, 是否同時定義了:

	name和filename屬性(有名檔案上傳)
	沒有定義name定義了filename(無名上傳)
	定義了name沒有定義filename(普通資料),

從而進行不同的處理.

if ((cd = php_mime_get_hdr_value(header, "Content-Disposition"))) {
	char *pair=NULL;
	int end=0;

	while (isspace(*cd)) {
		++cd;
	}

	while (*cd && (pair = php_ap_getword(&cd, `;`)))
	{
		char *key=NULL, *word = pair;

		while (isspace(*cd)) {
			++cd;
		}

		if (strchr(pair, `=`)) {
			key = php_ap_getword(&pair, `=`);

			if (!strcasecmp(key, "name")) {
				//獲取name欄位
				if (param) {
					efree(param);
				}
				param = php_ap_getword_conf(&pair TSRMLS_CC);
			} else if (!strcasecmp(key, "filename")) {
				//獲取filename欄位
				if (filename) {
					efree(filename);
				}
				filename = php_ap_getword_conf(&pair TSRMLS_CC);
			}
		}
		if (key) {
			efree(key);
		}
		efree(word);
	}

在這個過程中, PHP會去檢查普通資料中,是否有MAX_FILE_SIZE.

 /* Normal form variable, safe to read all data into memory */
if (!filename && param) {
	unsigned int value_len;
	char *value = multipart_buffer_read_body(mbuff, &value_len TSRMLS_CC);
	unsigned int new_val_len; /* Dummy variable */
	......

	if (!strcasecmp(param, "MAX_FILE_SIZE")) {
                  max_file_size = atol(value);
    }

	efree(param);
	efree(value);
	continue;
}

有的話, 就會按照它的值來檢查檔案大小是否超出.

if (PG(upload_max_filesize) > 0 && total_bytes > PG(upload_max_filesize)) {
	cancel_upload = UPLOAD_ERROR_A;
} else if (max_file_size && (total_bytes > max_file_size)) {
#if DEBUG_FILE_UPLOAD
	sapi_module.sapi_error(E_NOTICE,
		"MAX_FILE_SIZE of %ld bytes exceeded - file [%s=%s] not saved",
		 max_file_size, param, filename);
#endif
	cancel_upload = UPLOAD_ERROR_B;
}

通過上面的程式碼,我們也可以看到, 判斷分為倆部, 第一部分是檢查PHP預設的上傳上限. 第二部分才是檢查使用者自定義的MAX_FILE_SIZE, 所以表單中定義的MAX_FILE_SIZE並不能超過PHP中設定的最大上傳檔案大小.

通過對name和filename的判斷, 如果是檔案上傳, 會根據php的設定, 在檔案上傳目錄中建立一個隨機名字的臨時檔案:

 if (!skip_upload) {
	/* Handle file */
	fd = php_open_temporary_fd_ex(PG(upload_tmp_dir),
			 "php", &temp_filename, 1 TSRMLS_CC);
	if (fd==-1) {
		sapi_module.sapi_error(E_WARNING,
			 "File upload error - unable to create a temporary file");
		cancel_upload = UPLOAD_ERROR_E;
	}
}

返回檔案控制程式碼, 和臨時隨機檔名.

之後, 還會有一些驗證,比如檔名合法, name合法等.

如果這些驗證都通過, 那麼就把內容讀入, 寫入到這個臨時檔案中.

.....
else if (blen > 0) {
	wlen = write(fd, buff, blen); //寫入臨時檔案.
	if (wlen == -1) {
	/* write failed */
#if DEBUG_FILE_UPLOAD
	sapi_module.sapi_error(E_NOTICE, "write() failed - %s", strerror(errno));
#endif
	cancel_upload = UPLOAD_ERROR_F;
	}
}
....

當迴圈讀入完成後, 關閉臨時檔案控制程式碼. 記錄臨時變數名:

zend_hash_add(SG(rfc1867_uploaded_files), temp_filename,
	strlen(temp_filename) + 1, &temp_filename, sizeof(char *), NULL);

並且生成FILE變數, 這個時候, 如果是有名上傳, 那麼就會設定:

$_FILES[`userfile`] //name="userfile"

如果是無名上傳, 則會使用tmp_name來設定:

$_FILES[`tmp_name`] //無名上傳

最終交給使用者編寫的upload.php處理.

這時在upload.php中, 使用者就可以通過move_uploaded_file來操作剛才生成的檔案了~