您好,登錄后才能下訂單哦!
這篇文章主要介紹“PHP的phar怎么創建”的相關知識,小編通過實際案例向大家展示操作過程,操作方法簡單快捷,實用性強,希望這篇“PHP的phar怎么創建”文章能幫助大家解決問題。
Jar(Java Archive)文件,一個應用,包括所有的可執行,可訪問的文件,都打包進了一個JAR文件里,使得部署過程十分簡單。
類似于JAR。phar全稱為PHP Archive,phar擴展提供了一種將整個PHP應用程序放入.phar文件中的方法,以方便移動、安裝。phar文件的最大特點是將幾個文件組合成一個文件的便捷方式。.phar文件提供了一種將完整的PHP程序分布在一個文件中并從該文件中運行的方法。
與 JAR 不同的是Phar 可由 PHP 本身處理,因此不需要使用額外的工具來創建或使用,使用php腳本就能創建或提取它。
phar文件有三種格式:tar歸檔、zip歸檔、phar歸檔,前兩種執行需要php安裝Phar 擴展支持,用的也比較少,這里主要講phar歸檔格式。
PHAR文件缺省狀態是只讀的,使用Phar文件不需要任何的配置。部署非常方便。因為我們現在需要創建一個自己的Phar文件,所以需要允許寫入Phar文件,這需要修改一下 php.ini
我的php.ini文件中,phar.readonly = On。
[Phar] ; http://php.net/phar.readonly ;phar.readonly = On
首先在php.ini中修改phar.readonly這個選項,去掉前面的分號,并改值為off,由于安全原因該選項默認是on,如果在php.ini中是禁用的(值為0或off),那么在用戶腳本中可以開啟或關閉,如果在php.ini中是開啟的,那么用戶腳本是無法關閉的,所以這里設置為off來展示示例。
現在,我們就可以來把PHP應用打包成Phar文件了。
這里我都是借助別人博客的項目直接Copy的,并沒有進行演示,因為我整理本篇博客的初衷是為了解phar://漏洞打ctf的。所以其中的文件名就按照原作者的不進行修改了。最后會加上參考文章的。
首先我要按按照一個的規則創建應用的目錄結構,根目錄為project,project下的目錄如下面這樣:
file -yunek.js -yunke.css lib -lib_a.php template -msg.html index.php Lib.php
其中file文件夾有兩個內容為空的js和css文件,僅僅演示phar可以包含多種文件格式
lib_a.php內容如下:
<?php /** * Created by yunke. * User: yunke * Date: 2017/2/10 * Time: 9:23 */ function show(){ echo "l am show()"; }
msg.html內容如下:
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>phar</title> </head> <body> <?=$str; ?> </body> </html>
index.php內容如下:
<?php /** * Created by yunke. * User: yunke * Date: 2017/2/10 * Time: 9:17 */ require "lib/lib_a.php"; show(); $str = isset($_GET["str"]) ? $_GET["str"] : "hello world"; include "template/msg.html";
Lib.php內容如下:
<?php /** * Created by yunke. * User: yunke * Date: 2017/2/10 * Time: 9:20 */ function yunke() { echo "l am yunke()"; }
項目文件準備好了,現在在project文件夾同級目錄建立一個yunkeBuild.php,用于產生phar格式文件,內容如下:
<?php /** * Created by yunke. * User: yunke * Date: 2017/2/10 * Time: 9:36 */ //產生一個yunke.phar文件 $phar = new Phar('yunke.phar', 0, 'yunke.phar'); // 添加project里面的所有文件到yunke.phar歸檔文件 $phar->buildFromDirectory(dirname(__FILE__) . '/project'); //設置執行時的入口文件,第一個用于命令行,第二個用于瀏覽器訪問,這里都設置為index.php $phar->setDefaultStub('index.php', 'index.php');
然后在瀏覽器中訪問這個yunkeBuild.php文件,將產生一個yunke.phar文件,此時服務器根目錄結構如下:
project
yunkeBuild.php
yunke.phar
這就是產生一個phar歸檔文件最簡單的過程了。
這里我再做一些其他的補充,方便更好的理解:
1)phar文件的產生是通過訪問yunkeBuild.php,相當于執行。因此可以在終端執行如下代碼產生
aabouzekry@platinum:~/myapp$ php yunkeBuild.php
然后就產生了yunke.phar文件。
2)new phar()產生phar對象。對其中的參數進行一下解讀。
<?php $phar = new Phar("/yunke.phar", FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::KEY_AS_FILENAME, "yunke.phar");
解釋:
一個新 Phar
對象的創建通常需要三個參數。
第一個參數是Phar文件的路徑。你不僅可以通過它創建Phar文件,還可以對現存的Phar文件進行操作。
第二個參數是設定 Phar
對象如何處理文件。Phar
對象繼承了 PHP RecursiveDirectoryIterator
對象,這個參數是直接傳遞到父類里。這里提供的值是RecursiveDirectoryIterator
的缺省值,能滿足目前的要求。
第三個參數是Phar文件的別名,在內部引用這個Phar文件時都要使用這個別名。
通常只需傳入文件名。也就是第三個參數。
3) 往phar中添加文件。添加文件有幾種如下方法:
手動添加已有文件
調用類方法Phar::addFile($filepath,$localpath=?)
添加文件,參數是文件絕對路徑和(可選)存儲到phar的相對路徑
<?php $phar = new Phar('yunke.phar'); $phar->addFile('test.php'); include('phar://yunke.phar/test.php') // in test.php ?>
這里出現的phar://就是訪問phar文件的一種方法,所以不需要太在意。
以字符串添加文件內容
調用類方法Phar::addFromString($localpath,$contents)
以字符串形式添加文件
<?php $phar = new Phar('yunke.phar'); $phar->addFromString('test.php','<?php echo \'in test.php\'?>'); include('phar://yunke.phar/test.php'); // in test.php ?>
添加空目錄
調用類方法Phar::addEmptyDir($dirname)
添加空目錄,使用方法Phar::getContent()
獲取文件結構
<?php $phar = new Phar('yunke.phar'); $phar->addEmptyDir('test'); // yunke.phar/test/ ?>
手動選擇添加已有目錄
調用類方法Phar::buildFromDirectory($dir,$pattern = "")
添加整個目錄
<?php $phar = new Phar('yunke.phar'); $phar->buildFromDirectory('test'); // test.php in test/ include('phar://yunke.phar/test/test.php'); // in test/test.php ?>
4) 存根文件Stub,理解這個很重要。
歸檔文件中有一個存根文件stub,其實就是一段php執行代碼,在制作歸檔時可以設置,直接執行歸檔文件時,其實就是執行它,所以它是啟動文件;在腳本中包含歸檔文件時就像包含普通php文件一樣包含它并運行,但直接以phar://的方式包含歸檔中某一個文件時不會執行存根代碼, 往往在存根文件里面require包含要運行的其他文件,對存根文件的限制僅為以__HALT_COMPILER(); 結束,默認的存根設計是為在沒有phar擴展時能夠運行,它提取phar文件內容到一個臨時目錄再執行,不過從php5.3開始該擴展默認內置啟用了。
stub是phar文件的文件頭,格式為...<?php ...;__HALT_COMPILER();?>
,…可以是任意字符,包括留空,且php閉合符與最后一個分號之間不能有多于一個的空格符。另外php閉合符也可省略。最短省略閉合符的stub是<?php __HALT_COMPILER();?>
運行Phar文件時,stub文件被當做一個meta文件來初始化Phar, 并告訴Phar文件在被調用時該做什么。
在我們的例子中,使用的是 createDefaultStub()
方法。
其他的方式如下:
方法一:調用類方法Phar::setStub($string)
為實例創建自定義stub
<?php $phar = new Phar('yunke.phar'); $phar->setStub('<?php echo \'in stub!\';__HALT_COMPILER();?>'); include('phar://yunke.phar'); // in stub! ?>
也可以
$phar->setStub($phar->createDefaultStub("index.php"));
生成的缺省stub文件包含如下的代碼:
<?php Phar::mapPhar(); include "phar://yunke.phar/index.php"; __HALT_COMPILER();
createDefaultStub()
方法缺省創建的stub文件的內容很簡單。 Phar::mapPhar()
用來分析Phar文件的元數據,并初始化它。stub文件的結尾處需要調用 __HALT_COMPILER()
方法,這個方法后不能留空格。__HALT_COMPILER()
會立即終止PHP的運行,防止include的文件在此方法后仍然執行。這是Phar必須的,沒有它Phar將不能正常運行。
除此之外,我們還可以創建自己的stub文件來執行自定義的初始化過程,像這樣加載自定義文件
<?php $phar->setStub(file_get_contents("stub.php"));
方法二:使用默認stub,調用類方法Phar::setDefaultStub()
為實例設置默認stub,使用方法Phar::getStub()
獲取實例的stub
<?php $phar = new Phar('yunke.phar'); $phar->setDefaultStub(); print_r($phar->getStub()); // 2, 'c' => 'text/plain', 'cc' => 'text/plain', ... ?>
如果缺省創建stub,PHP會使用默認stub
<?php $phar = new Phar('yunke.phar'); $phar['demo.txt'] = 'demo'; print_r($phar->getStub()); // 2, 'c' => 'text/plain', 'cc' => 'text/plain', ... ?>
我們在服務器根目錄建立一個index.php文件來演示如何使用上面創建的phar文件,內容如下:
<?php /** * Created by yunke. * User: yunke * Date: 2017/2/8 * Time: 9:33 */ require "yunke.phar"; require "phar://yunke.phar/Lib.php"; yunke();
如果index.php文件中只有第一行,那么和不使用歸檔文件時,添加如下代碼完全相同:
require "project/index.php";
如果沒有第二行,那么第三行的yunke()將提示未定義,所以可見require一個phar文件時并不是導入了里面所有的文件,而只是導入了入口執行文件而已,但在實際項目中往往在這個入口文件里導入其他需要使用的文件,在本例中入口執行文件為project/index.php。
補充:
可以為歸檔設置別名,別名保存在歸檔文件中永久保存,它可以用一個簡短的名字引用歸檔,而不管歸檔文件在文件系統中存儲在那里,設置別名:
$phar = new Phar('lib/yunke.phar', 0); $phar->setAlias ( "yun.phar");
設置別名后可以如下使用:
<?php require "lib/yunke.phar"; require "phar://yun.phar/Lib.php"; //使用別名訪問歸檔文件 require "phar://lib/yunke.phar/Lib.php"; //當然仍然可以使用這樣的方式去引用
如果在制作phar文件時沒有指定別名,也可以在存根文件里面使用Phar::mapPhar('yunke.phar');指定。
我們有時候會好奇phar里面包含的文件源碼,這個時候就需要將phar文件還原,如果只是看一看的話可以使用一些ide工具,比如phpstorm 10就能直接打開它,如果需要修改那么就需要提取操作了,為了演示,我們下載一個composer.phar放在服務器目錄,在根目錄建立一個get.php文件,內容如下
<?php /** * Created by yunke. * User: yunke * Date: 2017/2/9 * Time: 19:02 */ $phar = new Phar('composer.phar'); $phar->extractTo('composer'); //提取一份原項目文件 $phar->convertToData(Phar::ZIP); //另外再提取一份,和上行二選一即可
用瀏覽器訪問這個文件,即可提取出來,以上列子展示了兩種提取方式:
第二行將建立一個composer目錄,并將提取出來的內容放入;
第三行將產生一個composer.zip文件,解壓即可得到提取還原的項目文件。
關于“PHP的phar怎么創建”的內容就介紹到這里了,感謝大家的閱讀。如果想了解更多行業相關的知識,可以關注億速云行業資訊頻道,小編每天都會為大家更新不同的知識點。
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。