Http Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	Http ($url= '')
	setURL ($url)
	setBasicAuthentication ($user, $password)
	getParameterString ($withPraefixQuestionMark=false)
	getUrl ()
	sendRedirect ()
	request ()
	serverError ($message)
	notAuthorized ($message)
	sendStatus ($status=501, $text='Internal Server Error', $message='')
	getAccept ()
Öffentliche, statische Methoden
	getLanguages ()
	getServer ()
Öffentliche Attribute
	$url = array()
	$header = array()
	$responseHeader = array()
	$requestParameter = array()
	$urlParameter = array()
	$method = 'GET'
	$error = ''
	$status = ''
	$body = ''

---

Ausführliche Beschreibung

Definiert in Zeile 11 der Datei Http.class.php.

---

Dokumentation der Elementfunktionen

Http::getAccept

(

)

Rückgabe:

Array Mime-Typen, welche vom User-Agent akzeptiert werden.

Definiert in Zeile 467 der Datei Http.class.php.

Wird benutzt von sendStatus().

     {
          $httpAccept = getenv('HTTP_ACCEPT');
          return $types = explode(',',$httpAccept);
     }

Http::getLanguages

(

)

[static]

Aus dem HTTP-Header werden die vom Browser angeforderten Sprachen gelesen.
Es wird eine Liste von Sprachen erzeugt.
Beispiel: 'de_DE','de','en_GB','en' ... usw.
Wenn der Browser 'de_DE' anfordert, wird hier auch 'de' (als Fallback) ermittelt.

Rückgabe:

Array

Definiert in Zeile 341 der Datei Http.class.php.

     {
          global $HTTP_SERVER_VARS;

          $languages = array();
          $http_languages = @$HTTP_SERVER_VARS['HTTP_ACCEPT_LANGUAGE'];
          foreach( explode(',',$http_languages) as $l )
          {
               list($part) = explode(';',$l); // Prioritäten ignorieren.
               $languages[] = trim($part);

               // Aus "de_DE" das "de" extrahieren.
               $languages[] = current(explode('_',str_replace('-','_',trim($part))));
          }

          return array_unique( $languages );
     }

Http::getParameterString

(

$

withPraefixQuestionMark = false

)

Erzeugt eine Zeichenkette mit allen Parametern.

Parameter:

withPraefixQuestionMark

Praefix mit Fragezeichen (für GET-Anfragen)

Rückgabe:

String URL-Parameter

Definiert in Zeile 104 der Datei Http.class.php.

Wird benutzt von getUrl() und request().

     {
          $parameterString = '';
          $parameter = $this->urlParameter + $this->requestParameter;
          
          if   ( ! empty($parameter) )
          {
               foreach( $this->requestParameter as $paramName => $paramValue )
               {
                    if   ( strlen($parameterString) > 0)
                         $parameterString .= '&';
                    elseif    ( $withPraefixQuestionMark )
                         $parameterString .= '?';
                         
                    $parameterString .= urlencode($paramName) . '=' .urlencode($paramValue);
               }
          }
          
          return $parameterString;
     }

Http::getServer

(

)

[static]

Ermittelt die aktuelle URL des Requests (ohne Datei).

Rückgabe:

String URL

Definiert in Zeile 366 der Datei Http.class.php.

Wird benutzt von Value::generate() und OpenId::redirect().

     {
          $https = getenv('HTTPS');
          
          if   ( $https )
               $server = 'https://';
          else
               $server = 'http://';
               
          $server .= getenv('SERVER_NAME').dirname(getenv('REQUEST_URI'));
          
          return $server;
     }

Http::getUrl

(

)

Sendet eine Redirect-Anweisung an den Browser.

Rückgabe:

String URL

Definiert in Zeile 130 der Datei Http.class.php.

Benutzt getParameterString().

Wird benutzt von sendRedirect().

     {
          $location = $this->url['scheme'];
          $location .= '://'; 
          $location .= $this->url['host'];
          if   ( $this->url['scheme'] == 'http'  && $this->url['port'] != 80  ||
                 $this->url['scheme'] == 'https' && $this->url['port'] != 443    )
               $location .= ':'.$this->url['port'];
          $location .= $this->url['path'];
               
          $location .= $this->getParameterString(true);

          if   ( isset($this->url['fragment']) )
               $location .= '#'.$this->url['fragment'];
          
          return $location;
     }

Http::Http

(

$

url = ''

)

Erzeugt eine HTTP-Anfrage.

Parameter:

String

URL

Rückgabe:

Http

Definiert in Zeile 39 der Datei Http.class.php.

Benutzt $url und setURL().

     {
          $this->setURL( $url );
          $this->header[] = 'User-Agent: Mozilla/5.0 (OpenRat CMS)';
          $this->header[] = 'Connection: close';
     }

Http::notAuthorized

(

$

message

)

Erzeugt einen "HTTP 501 Internal Server Error".

Parameter:

String

$message Eigener Hinweistext

Definiert in Zeile 400 der Datei Http.class.php.

Benutzt sendStatus().

Wird benutzt von AdministrationTree::root().

     {

          Http::sendStatus(403,'Not Authorized',$message);
     }

Http::request

(

)

Erzeugt den HTTP-Request

Rückgabe:

boolean Erfolg der Anfrage.

Definiert in Zeile 166 der Datei Http.class.php.

Benutzt getParameterString() und setURL().

     {
          $this->error  = '';
          $this->status = '';

          $errno  = 0;
          $errstr = '';

          if   ( empty($this->url['host']) )
          {
               $this->error = "No hostname specified";
               return false;
          }
          
          // RFC 1945 (Section 9.3) says:
          // A user agent should never automatically redirect a request
          // more than 5 times, since such redirections usually indicate an infinite loop.
          for( $r=1; $r<=5; $r++ )
          {
               // Die Funktion fsockopen() erwartet eine Protokollangabe (bei TCP optional, bei SSL notwendig).
               if   ( $this->url['scheme'] == 'https' || $this->url['port'] == '443' )
                    $prx_proto = 'ssl://'; // SSL
               else
                    $prx_proto = 'tcp://'; // Default
                    
               $fp = @fsockopen ($prx_proto.$this->url['host'],$this->url['port'], $errno, $errstr, 30);
     
               if   ( !$fp || !is_resource($fp) )
               {
                    // Keine Verbindung zum Host moeglich.
                    $this->error = "Connection refused: '".$prx_proto.$this->url['host'].':'.$this->url['port']." - $errstr ($errno)";
                    return false;
               }
               else
               {
                    $lb = "\r\n";
                    $http_get = $this->url['path'];

                    $parameterString = $this->getParameterString();

                    if   ( $this->method == 'GET')
                         if   ( !empty($parameterString) )
                              $http_get .= '?'.$parameterString;

                    if   ( $this->method == 'POST' )
                    {
                         $this->header[] = 'Content-Type: application/x-www-form-urlencoded';
                         $this->header[] = 'Content-Length: '.strlen($parameterString);
                    }
                              
                    $this->header[] = 'Host: '.$this->url['host'];
                    $this->header[] = 'Accept: */*';
                    $request_header = array( $this->method.' '.$http_get.' HTTP/1.0') + $this->header;
                    $http_request = implode($lb,$request_header).$lb.$lb;
                    
                    if   ( $this->method == 'POST' )
                         $http_request .= $parameterString;

                    if (!is_resource($fp)) {
                         $this->error = 'Connection lost after connect: '.$prx_proto.$this->url['host'].':'.$this->url['port'];
                         return false;
                    }
                    fputs($fp, $http_request); // Die HTTP-Anfrage zum Server senden.

                    // Jetzt erfolgt das Auslesen der HTTP-Antwort.
                    $isHeader = true;

                    // RFC 1945 (Section 6.1) schreibt als Statuszeile folgendes Format vor
                    // "HTTP/" 1*DIGIT "." 1*DIGIT SP 3DIGIT SP
                    if (!is_resource($fp)) {
                         $this->error = 'Connection lost during transfer: '.$this->url['host'].':'.$this->url['port'];
                         return false;
                    }
                    elseif (!feof($fp)) {
                         $line = fgets($fp,1028);
                         $this->status = substr($line,9,3);
                    }
                    else
                    {
                         $this->error = 'Unexpected EOF while reading HTTP-Response';
                         return false;
                    }
                    
                    while (!feof($fp)) {
                         $line = fgets($fp,1028);
                         if   ( $isHeader && trim($line)=='' ) // Leerzeile nach Header.
                         {
                              $isHeader = false;
                         }
                         elseif( $isHeader )
                         {
                              list($headerName,$headerValue) = explode(': ',$line) + array(1=>'');
                              $this->responseHeader[$headerName] = trim($headerValue);
                         }
                         else
                         {
                              $this->body .= $line;
                         }
                    }
//                  Html::debug($this->url,"URL");
//                  Html::debug($http_request,"REQUEST komplett");
//                  Html::debug($this->responseHeader);
//                  Html::debug($this->body,'BODY');
//                  echo "<pre>";
//                  echo "REQUEST=".nl2br($http_request);
//                  echo "HEADER=".nl2br(htmlentities(implode("\n",$this->responseHeader)));
//                  echo "BODY=".nl2br(htmlentities($this->body));
//                  echo "</pre>";
                    fclose($fp); // Verbindung brav schließen.


                    // RFC 1945 (Section 6.1.1) schreibt
                    // "[...] However, applications must understand the class of any status code, as
                    // indicated by the first digit"
                    // Daher interessiert uns nur die erste Stelle des 3-stelligen HTTP-Status.

                    // 301 Moved Permanently
                    // 302 Moved Temporarily
                    if   ( $this->status == '301' ||
                           $this->status == '302'   )
                    {
                         $location = @$this->responseHeader['Location'];
                         if   ( empty($location) )
                         {
                              $this->error = '301/302 Response without Location-header';
                              return false;
                         }
                         
//                       Html::debug($this->url,"alte URL");
//                       Html::debug($location,"NEUES REDIRECT AUF");
                         $this->setURL($location);
//                       Html::debug($this->url,"NEUE URL NACH REDIRECT");
                         continue; // Nächster Versuch mit umgeleiteter Adresse.
                    }
                    // RFC 1945 (Section 6.1.1) schreibt
                    // "2xx: Success - The action was successfully received, understood, and accepted."
                    elseif    ( substr($this->status,0,1) == '2' )
                    {
                         return true;
                    }
                    elseif    ( substr($this->status,0,1) == '4' )
                    {
                         $this->error = 'Client Error: '.$this->status;
                         return false;
                    }
                    elseif    ( substr($this->status,0,1) == '5' )
                    {
                         $this->error = 'Server Error: '.$this->status;
                         return false;
                    }
                    else
                    {
                         $this->error = 'Unexpected HTTP-Status: '.$this->status. '; this is mostly a client error, sorry.';
                         return false;
                    }
               }

               $this->error = 'Too much redirects, infinite loop assumed. Exiting. Last URL: '.$http_get;
               return false;

          }

     }

Http::sendRedirect

(

)

Sendet eine Redirect-Anweisung mit der aktuellen URL an den Browser.

Definiert in Zeile 152 der Datei Http.class.php.

Benutzt getUrl().

     {
          $location = $this->getUrl();
          
          header('Location: '.$location);
          exit;
     }

Http::sendStatus	(	$	status = 501,
		$	text = 'Internal Server Error',
		$	message = ''
	)

Schickt einen HTTP-Status zum Client und beendet das Skript.

Parameter:

	Integer	$status HTTP-Status
	String	$text HTTP-Meldung
	String	$message Eigener Hinweistext

Definiert in Zeile 415 der Datei Http.class.php.

Benutzt $status und getAccept().

Wird benutzt von Preferences::load(), notAuthorized(), FolderAction::reorder() und serverError().

     {
          if   ( headers_sent() )
          {
               echo "$status $text\n$message";
               exit;
          }
          
          header('HTTP/1.0 '.intval($status).' '.$text);
          
          
          $types = Http::getAccept();
          
          if   ( sizeof($types)==1 && in_array('application/json',$types) )
          {
               header('Content-Type: application/json');
               require_once( OR_SERVICECLASSES_DIR."JSON.class.".PHP_EXT );
               $json = new JSON();
               echo $json->encode( array('status'=>$status,'error'=>$text,'description'=>$message) );
          }
          elseif    ( sizeof($types)==1 && in_array('application/xml',$types) )
          {
               header('Content-Type: application/xml');
               require_once( OR_SERVICECLASSES_DIR."XML.class.".PHP_EXT );
               $xml = new XML();
               $xml->root='error';
               echo $xml->encode( array('status'=>$status,'error'=>$text,'description'=>$message) );
          }
          else
          {
               header('Content-Type: text/html');
               $signature = OR_TITLE.' '.OR_VERSION.' '.getenv('SERVER_SOFTWARE');
               echo <<<HTML
<html>
<head><title>$status $text - OpenRat</title></head>
<body>
<h1>$text</h1>
<p>$message</p>
<hr>
<address>$signature</adddress>
</body>
</html>
HTML;
          }
          exit;
     }

Http::serverError

(

$

message

)

Erzeugt einen "HTTP 501 Internal Server Error".

Parameter:

String

$message Eigener Hinweistext

Definiert in Zeile 387 der Datei Http.class.php.

Benutzt sendStatus().

Wird benutzt von ProjectAction::addproject(), Logger::doLog(), PageelementAction::edit(), filemanagerErrorHandler(), Action::forward(), User::getAvailableStyles() und FolderAction::multiple().

     {

          Http::sendStatus(501,'Internal Server Error',$message);
     }

Http::setBasicAuthentication	(	$	user,
		$	password
	)

Setzt Authentisierungsinformationen in den HTTP-Request.

Parameter:

	String	Benutzername
	String	Kennwort

Definiert in Zeile 92 der Datei Http.class.php.

     {
          $this->header[] = 'Authorization: Basic '.base64_encode($user.':'.$password);
     }

Http::setURL

(

$

url

)

Setzt die URL.

Parameter:

String

URL

Definiert in Zeile 53 der Datei Http.class.php.

Benutzt $url.

Wird benutzt von Http() und request().

     {
//        Html::debug($url,"neue url");
          $this->url = parse_url($url);
//        Html::debug($this->url,"direkt nach parse_url");

          if   ( empty($this->url['host']) && !empty($this->url['path']) )
          {
               $this->url['host'] = basename($this->url['path']);
               $this->url['path'] = '/';
          }

          if   ( empty($this->url['path']) )
               $this->url['path'] = '/';

          if   ( !isset($this->url['port']) )
               if   ( !isset($this->url['scheme']) )
               {
                    $this->url['scheme'] = 'http'; // Standard-Port.
                    $this->url['port']   = 80; // Standard-Port.
               }
               elseif    ( $this->url['scheme'] == 'https' )
                    $this->url['port'] = 443; // SSL-Port.
               else
                    $this->url['port'] = 80; // Standard-Port.
          
          if   ( !empty($this->url['query']) )
               parse_str( $this->url['query'],$this->urlParameter );

     }

---

Dokumentation der Datenelemente

Http::$body = ''

Definiert in Zeile 29 der Datei Http.class.php.

Http::$error = ''

Definiert in Zeile 27 der Datei Http.class.php.

Http::$header = array()

Definiert in Zeile 14 der Datei Http.class.php.

Http::$method = 'GET'

Definiert in Zeile 26 der Datei Http.class.php.

Http::$requestParameter = array()

Definiert in Zeile 16 der Datei Http.class.php.

Http::$responseHeader = array()

Definiert in Zeile 15 der Datei Http.class.php.

Http::$status = ''

Definiert in Zeile 28 der Datei Http.class.php.

Wird benutzt von sendStatus().

Http::$url = array()

Definiert in Zeile 13 der Datei Http.class.php.

Wird benutzt von Http() und setURL().

Http::$urlParameter = array()

Definiert in Zeile 17 der Datei Http.class.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• serviceClasses/Http.class.php