PHP: fopen - Manual

Opis

resource fopen ( string nazwa_pliku, string tryb [, bool użyj_include_path [, resource zkontekst]] )

fopen() wiąże nazwany zasób, określony przez przez nazwa_pliku do strumienia. Jeśli nazwa_pliku jest w formacie "schemat://...", PHP przyjmuje, że to jest URL i rozpoczyna poszukiwanie programu obsługi protokołu (róznież zwanego wrapperem) dla tego schematu. Jeśli nie ma zarejestrowanego wrappera dla tego protokołu, PHP wyświetli wiadomość aby pomóc Tobie namierzyć potencjalne problemy w Twoim skrypcie i będzie kontynuować pracę, traktując podany nazwa_pliku jako zwykły plik.

Jeśli PHP zdecyduje, że nazwa_pliku określa lokalny plik, wtedy spróbuje otworzyć strumień na tym pliku. Plik musi być dostępny dla PHP, więc musisz zapewnić prawa dostępu do pliku pozwalające na taką operację. Jeśli masz włączone tryb bezpieczny lub open_basedir mogą mieć zastosowanie dodatkowe restrykcje.

Jeśli PHP zdecyduje, że nazwa_pliku określa zarejestrowany protokół i ten protokół jest zarejestowany jako sieciowy URL, PHP sprawdzi allow_url_fopen czy jest włączone. Jeśli jest wyłączone (off), PHP wyświetli ostrzeżenie i wywołanie fopen zakończy się niepowodzeniem.

Notatka: Listę obsługiwanych protokołów możesz znaleźć w Dodatek L. Niektóre protokoły (również określane przez wrappery obsługują kontekst lub/i opcje php.ini. Odwołaj się do konkretnej strony protokołu aby uzyskać listę opcji jakie mogą zostać ustawione (np. php.ini wartość user_agent używana przez wrapper http).

Notatka: Wsparcie dla kontekstów zostało dodane w PHP 5.0.0.

Notatka: Od PHP 4.3.2 domyślny tryb ustawiany jest na binarny, dla wszystkich platform, które rozróżniają tryby binarne i tekstowe. Jeśli masz problemy ze skryptem po aktualizacji, spróbuj użyć flagi 't' jako obejście dopóki nie uczynisz Twojego skryptu bardziej przenośnym jak opisano niżej.

Parametr tryb określa rodzaj dostępu jaki wymagasz do strumienia. Może być dowolny z następujących:

Tabela 1. Lista możliwych trybów dla fopen() używając tryb

`tryb`	Opis
`'r'`	Otwiera tylko do odczytu; umieszcza wskaźnik pliku na jego początku.
`'r+'`	Otwiera do odczytu i zapisu; umieszcza wskaźnik pliku na jego początku.
`'w'`	Otwiera tylko do zapisu; umieszcza wskaźnik pliku na jego początku i obcina plik do zerowej długości. Jeśli plik nie istnieje to próbuje go utworzyć.
`'w+'`	Otwiera do odczytu i zapisu; umieszcza wskaźnik pliku na jego początku i obcina plik do zerowej długości. Jeśli plik nie istnieje to próbuje go utworzyć.
`'a'`	Otwiera tylko do zapisu; umieszcza wskaźnik pliku na jego końcu. Jeśli plik nie istnieje to próbuje go utworzyć.
`'a+'`	Otwiera do odczytu i zapisu; umieszcza wskaźnik pliku na jego końcu. Jeśli plik nie istnieje to próbuje go utworzyć.
`'x'`	Tworzy i otwiera plik tylko do zapisu; umieszcza wskaźnik pliku na jego początku. Jeśli plik juz istnieje, wywołanie fopen() nie powiedzie się, zwróci `FALSE` i wygeneruje błąd na poziomie `E_WARNING`. Jeśli plik nie istnieje, spróbuje go utworzyć. To jest równoważne z określeniem flag `O_EXCL\|O_CREAT` stosowanym w wywołaniu systemowym `open(2)`. Ta opcja jest obsługiwana w PHP 4.3.2 i późniejszych i działa tylko na plikach lokalnych.
`'x+'`	Tworzy i otwiera plik odczytu i zapisu; umieszcza wskaźnik pliku na jego początku. Jeśli plik juz istnieje, wywołanie fopen() nie powiedzie się, zwróci `FALSE` i wygeneruje błąd na poziomie `E_WARNING`. Jeśli plik nie istnieje, spróbuje go utworzyć. To jest równoważne z okresleniem flag `O_EXCL\|O_CREAT` stosowanym w wywołaniu systemowym `open(2)`. Ta opcja jest obsługiwana w PHP 4.3.2 i późniejszych i działa tylko na plikach lokalnych.

Notatka: Różne rodziny systemów operacyjnych stosuja rózne konwencje końca lini. Kiedy zapisujesz plik tekstowy i chcesz wstawić łamanie lini, musisz użyć poprawnych dla twojego systemu operacyjnego znak(ów) końca lini. Systemy bazujące na Uniksie używają \n jako znaku końca lini, systemy bazujące na Windowsie używają \r\n jako znaków końca lini, a systemy Macintosh używają \r jako znak końca lini.
Jeśli użyjesz nieprawidłowego końca lini do zapisu pliku, możesz zaobserwować, w innych aplikacjach otwierając ten plik, że "wygląda on zabawnie".
Windows oferuje flagę ('t') konwertującą tryb tekstowy, która przezroczyście przekłada \n na \r\n kiedy pracujesz z plikiem. Dla kontrastu, możesz także uzyć 'b' aby wymusić tryb binarny, wtedy nie będzie konwertować twoich danych. Aby użyć tych flag, wstaw 'b' lub 't' jako ostatni znak w parametrze tryb.
Domyślnie tryb konwersji zależy od SAPI i wersji PHP jakiej używasz, więc namawiamy aby zawsze podawać stosowną flage w celu przenośności. Powinieneś użyć trybu 't' jeśli pracujesz ze zwykłymi plikami tekstowymi (plain-text)i używasz \n do ograniczenia konców lini w twoim skrypcie, ale wymagasz aby twój plik był czytelny w aplikacjach takich jak notatnik. Powinieneś uzyć 'b' w każdym innym przypadku.
Jeśli nie podasz flagi 'b' kiedy pracujesz na binarnych plikach, możesz doświadczyć dziwnych problemów z twoimi danymi, włączając uszkodzone pliki graficzne i dziwne problemy ze znakami \r\n.

Notatka: Dla przenośności, bardzo zalecane jest użycie zawsze flagi 'b' kiedy otwierasz pliki za pomocą fopen().

Notatka: Ponownie, dla przenośności, jest również bardzo zalecane abyś, przepisał swój kod, który używa lub polega na trybie 't' tak aby używał poprawnego końca lini oraz trybu 'b'.

Opcjonalny trzeci parametr użyj_include_path może być ustawiony na '1' lub TRUE jeśli chcesz szukać pliku także w include_path.

Jeśli otwieranie się nie powiedzie, funkcja zwróci FALSE i wygenerowany zostanie błąd na poziomie E_WARNING. Możesz użyć @ aby zatuszować to ostrzeżenie.

Przykład 1. fopen() przykłady


<?php

$handle = fopen("/home/rasmus/plik.txt", "r");

$handle = fopen("/home/rasmus/plik.gif", "wb");

$handle = fopen("http://www.przyklad.com/", "r");

$handle = fopen("ftp://uzytkownik:haslo@przyklad.com/jakisplik.txt", "w");

?>

Jeśli doświadczasz problemów z odczytem lub zapisywaniem do plików i używasz PHP w postaci modułu serwera, pamiętaj, żeby się upewnić, że pliki i katalogi, których używasz są dostępne dla procesu serwera.

Na platformie Windows, dbaj aby wstawiać znaki ucieczki (escape) przed wszystkimi lewymi ukośnikami (backslash) użytymi w ścieżce do pliku lub używać ukośników (slash).


<?php

$handle = fopen("c:\\data\\info.txt", "r");

?>

Ostrzeżenie

Łącząc się przez SSL, serwer Microsoft IIS pogwałca reguły protokołu przez zamknięcie połączenia bez wysłania znacznika close_notify. PHP zgłosi to jako "SSL: Fatal Protocol Error" po przesłaniu całości danych. Aby obejść ten błąd, wystarczy obniżyć poziom raportowania błędów (error_reporting) aby nie były wyświetlane ostrzeżenia. PHP w wersji 4.3.7 i nowsze wykrywa obecność zepsutego serwera IIS przy otwieraniu strumienia przez wrapper https:// i wyłącza wyświetlanie tych ostrzeżeń. Używając funkcji fsockopen() do otwarcia gniazda ssl:// należy samemu zatroszczyć się o wyłączenie ostrzeżeń.

Notatka: Kiedy włączony jest tryb bezpieczny, PHP sprawdza czy katalog, na którym chcesz operować, ma takie same UID (owner) jak skrypt, który jest aktualnie wykonywany.

Patrz także: Dodatek L, fclose(), fgets(), fread(), fwrite(), fsockopen(), file(), file_exists(), is_readable(), stream_set_timeout() i popen().

User Contributed Notes


Simple class to fetch a HTTP URL. Supports "Location:"-redirections. Useful for servers with allow_url_fopen=false. Works with SSL-secured hosts.



<?php

#usage:

$r = new HTTPRequest('http://www.php.net');

echo $r->DownloadToString();



class HTTPRequest

{

    var $_fp;        // HTTP socket

    var $_url;        // full URL

    var $_host;        // HTTP host

    var $_protocol;    // protocol (HTTP/HTTPS)

    var $_uri;        // request URI

    var $_port;        // port

    

    // scan url

    function _scan_url()

    {

        $req = $this->_url;

        

        $pos = strpos($req, '://');

        $this->_protocol = strtolower(substr($req, 0, $pos));

        

        $req = substr($req, $pos+3);

        $pos = strpos($req, '/');

        if($pos === false)

            $pos = strlen($req);

        $host = substr($req, 0, $pos);

        

        if(strpos($host, ':') !== false)

        {

            list($this->_host, $this->_port) = explode(':', $host);

        }

        else 

        {

            $this->_host = $host;

            $this->_port = ($this->_protocol == 'https') ? 443 : 80;

        }

        

        $this->_uri = substr($req, $pos);

        if($this->_uri == '')

            $this->_uri = '/';

    }

    

    // constructor

    function HTTPRequest($url)

    {

        $this->_url = $url;

        $this->_scan_url();

    }

    

    // download URL to string

    function DownloadToString()

    {

        $crlf = "\r\n";

        

        // generate request

        $req = 'GET ' . $this->_uri . ' HTTP/1.0' . $crlf

            .    'Host: ' . $this->_host . $crlf

            .    $crlf;

        

        // fetch

        $this->_fp = fsockopen(($this->_protocol == 'https' ? 'ssl://' : '') . $this->_host, $this->_port);

        fwrite($this->_fp, $req);

        while(is_resource($this->_fp) && $this->_fp && !feof($this->_fp))

            $response .= fread($this->_fp, 1024);

        fclose($this->_fp);

        

        // split header and body

        $pos = strpos($response, $crlf . $crlf);

        if($pos === false)

            return($response);

        $header = substr($response, 0, $pos);

        $body = substr($response, $pos + 2 * strlen($crlf));

        

        // parse headers

        $headers = array();

        $lines = explode($crlf, $header);

        foreach($lines as $line)

            if(($pos = strpos($line, ':')) !== false)

                $headers[strtolower(trim(substr($line, 0, $pos)))] = trim(substr($line, $pos+1));

        

        // redirection?

        if(isset($headers['location']))

        {

            $http = new HTTPRequest($headers['location']);

            return($http->DownloadToString($http));

        }

        else 

        {

            return($body);

        }

    }

}

?>


This function has a basic implementation of HTTP Digest Authentication (as per RFC 2617) to get a file from a web server which requires digest authentication (as opposed to basic authentication - the difference being that, with basic, your password is sent to the server as plain text, whereas with digest, it is hashed with a server-supplied nonce to protect against sniffing and replay attacks). 



You just supply the host (e.g www.example.com), the name of the file you want (e.g protected_page.html), and the necessary username and password, and the function returns the contents of the protected file (or the error message that the server sends, if you supplied the wrong credentials).



If the server only supports a QOP of auth-int (rather then auth) this function won't work, but can be easily modified with reference to the RFC at http://www.ietf.org/rfc/rfc2617.txt



<?php

function readHTTPDigestAuthenticatedFile($host,$file,$username,$password)

{

    if (!$fp=fsockopen($host,80, $errno, $errstr, 15))

        return false;

        

    //first do the non-authenticated header so that the server

    //sends back a 401 error containing its nonce and opaque

    $out = "GET /$file HTTP/1.1\r\n";

       $out .= "Host: $host\r\n";

       $out .= "Connection: Close\r\n\r\n";



     fwrite($fp, $out);



    //read the reply and look for the WWW-Authenticate element

    while (!feof($fp))

    {

        $line=fgets($fp, 512);

        

        if (strpos($line,"WWW-Authenticate:")!==false)

            $authline=trim(substr($line,18));

    }

    

    fclose($fp);

       

    //split up the WWW-Authenticate string to find digest-realm,nonce and opaque values

    //if qop value is presented as a comma-seperated list (e.g auth,auth-int) then it won't be retrieved correctly

    //but that doesn't matter because going to use 'auth' anyway

    $authlinearr=explode(",",$authline);

    $autharr=array();

    

    foreach ($authlinearr as $el)

    {

        $elarr=explode("=",$el);

        //the substr here is used to remove the double quotes from the values

        $autharr[trim($elarr[0])]=substr($elarr[1],1,strlen($elarr[1])-2);

    }

    

    foreach ($autharr as $k=>$v)

        echo("$k ==> $v\r\n");

    

    //these are all the vals required from the server

    $nonce=$autharr['nonce'];

    $opaque=$autharr['opaque'];

    $drealm=$autharr['Digest realm'];

    

    //client nonce can be anything since this authentication session is not going to be persistent

    //likewise for the cookie - just call it MyCookie

    $cnonce="sausages";

    

    //calculate the hashes of A1 and A2 as described in RFC 2617

    $a1="$username:$drealm:$password";$a2="GET:/$file";

    $ha1=md5($a1);$ha2=md5($a2);

    

    //calculate the response hash as described in RFC 2617

    $concat = $ha1.':'.$nonce.':00000001:'.$cnonce.':auth:'.$ha2;

    $response=md5($concat);

    

    //put together the Authorization Request Header

    $out = "GET /$file HTTP/1.1\r\n";

       $out .= "Host: $host\r\n";

    $out .= "Connection: Close\r\n";

    $out .= "Cookie: cookie=MyCookie\r\n";

    $out .= "Authorization: Digest username=\"$username\", realm=\"$drealm\", qop=\"auth\", algorithm=\"MD5\", uri=\"/$file\", nonce=\"$nonce\", nc=00000001, cnonce=\"$cnonce\", opaque=\"$opaque\", response=\"$response\"\r\n\r\n";

    

    if (!$fp=fsockopen($host,80, $errno, $errstr, 15))

        return false;

    

    fwrite($fp, $out);

    

    //read in a string which is the contents of the required file

    while (!feof($fp))

    {

        $str.=fgets($fp, 512);

    }

    

    fclose($fp);

    

    return $str;

}



?>