Your browser must have JavaScript enabled in order to view this page.
> >
 
Welcome Guest#217 Login/register    Go to Bottom


INSTALL | LICENSE | README | CHANGES | Class Tree | Index
Go to Top

Source for file dpserver.php

Documentation is available at dpserver.php

  1. <?php
  2. /**
  3.  * Provides 'DpServer' class to answer normal and AJAX requests from web clients
  4.  *
  5.  * DutchPIPE version 0.4; PHP version 5
  6.  *
  7.  * LICENSE: This source file is subject to version 1.0 of the DutchPIPE license.
  8.  * If you did not receive a copy of the DutchPIPE license, you can obtain one at
  9.  * http://dutchpipe.org/license/1_0.txt or by sending a note to
  10.  * license@dutchpipe.org, in which case you will be mailed a copy immediately.
  11.  *
  12.  * @package    DutchPIPE
  13.  * @subpackage lib
  14.  * @author     Lennert Stock <ls@dutchpipe.org>
  15.  * @copyright  2006, 2007 Lennert Stock
  16.  * @license    http://dutchpipe.org/license/1_0.txt  DutchPIPE License
  17.  * @version    Subversion: $Id: dpserver.php 278 2007-08-19 22:52:25Z ls $
  18.  * @link       http://dutchpipe.org/manual/package/DutchPIPE
  19.  * @see        dpclient.php, dpuniverse.php
  20.  */
  21.  
  22. /* Shows all possible errors */
  23. error_reporting(E_ALL | E_STRICT);
  24.  
  25. /**
  26.  * A DutchPIPE server to answer normal and AJAX requests from web clients
  27.  *
  28.  * The DutchPIPE server which can be started and then keeps running while
  29.  * accepting socket connections. Waits for and accepts socket requests from
  30.  * users connected through dpclient.php, and returns output to dpclient.php,
  31.  * which returns it to the end user. If there are 10 users on the site, it will
  32.  * loop through the main code for each user at a time.
  33.  *
  34.  * To answer each request, the server passes the request on to the persistent
  35.  * DbUniverse object, where the real processing takes place.
  36.  *
  37.  * @package    DutchPIPE
  38.  * @subpackage lib
  39.  * @author     Lennert Stock <ls@dutchpipe.org>
  40.  * @copyright  2006, 2007 Lennert Stock
  41.  * @license    http://dutchpipe.org/license/1_0.txt  DutchPIPE License
  42.  * @version    Release: 0.2.1
  43.  * @link       http://dutchpipe.org/manual/package/DutchPIPE
  44.  * @see        dpclient.php, dpuniverse.php
  45.  */
  46. final class DpServer
  47. {
  48.     /**
  49.      * @var         resource  The socket the server has opened to a client
  50.      * @access      private
  51.      */
  52.      private $mMsgsock;
  53.  
  54.     /**
  55.      * @var         resource  Used to show server status info on the cmd line
  56.      * @access      private
  57.      */
  58.     private $mShowedStatusHeader = 0;
  59.  
  60.     /**
  61.      * Used to show server status info based on getrusage, start "user" time of
  62.      * script
  63.      *
  64.      * @var         resource  Start 'user' time of script
  65.      * @access      private
  66.      */
  67.     private $mUtimeBefore;
  68.  
  69.     /**
  70.      * Used to show server status info based on getrusage, start "system" time
  71.      * of script
  72.      *
  73.      * @var         resource  Start "system" time of script
  74.      * @access      private
  75.      */
  76.     private $mStimeBefore;
  77.  
  78.     /**
  79.      * Sets up the server at object creation time based on your settings
  80.      *
  81.      * @param       string    $iniFile    Path to a dpserver-ini.php like file
  82.      */
  83.     function __construct($iniFile = 'dpserver-ini.php')
  84.     {
  85.         /* Used by showStatus() further below */
  86.         if (function_exists('getrusage')) {
  87.             $rusage = getrusage();
  88.             $this->mUtimeBefore = (int)$rusage["ru_utime.tv_sec"] * 1e6 +
  89.                 (int)$rusage["ru_utime.tv_usec"];
  90.             $this->mStimeBefore = (int)$rusage["ru_stime.tv_sec"] * 1e6 +
  91.                 (int)$rusage["ru_stime.tv_usec"];
  92.         }
  93.  
  94.         /* Get the server settings */
  95.         require_once($iniFile);
  96.  
  97.         require_once(DPSERVER_LIB_PATH . 'dpmbstring_'
  98.             . (!DPSERVER_ENABLE_MBSTRING || !function_exists('mb_strlen')
  99.             ? 'disabled' : 'enabled') . '.php');
  100.  
  101.         error_reporting(DPSERVER_ERROR_REPORTING);
  102.  
  103.         ini_set('memory_limit', DPSERVER_MEMORY_LIMIT);
  104.  
  105.         /* Allow the script to hang around waiting for connections */
  106.         set_time_limit(DPSERVER_MAXUPTIME);
  107.  
  108.         /* See what we're getting as it comes in */
  109.         ob_implicit_flush();
  110.  
  111.         date_default_timezone_set(DPSERVER_TIMEZONE);
  112.     }
  113.  
  114.     /**
  115.      * Starts the DutchPIPE server, using a specific 'universe' object
  116.      *
  117.      * Also see: http://www.php.net/sockets
  118.      *
  119.      * @param       object    &$universe   An instance of DpUniverse
  120.      */
  121.     function runDpServer(&$universe)
  122.     {
  123.         /* Check if the server is already running */
  124.         if (file_exists(DPSERVER_SOCKET_PATH)) {
  125.             /* :KLUDGE: should be improved */
  126.             unlink(DPSERVER_SOCKET_PATH);
  127.             //die(dp_text("Cannot start server: server already running\n"));
  128.         }
  129.  
  130.         if (DPSERVER_SOCKET_TYPE === AF_UNIX) {
  131.             /* Initialize the server, first create a socket */
  132.             if (FALSE === ($socket = socket_create(AF_UNIX, SOCK_STREAM, 0))) {
  133.                 die(sprintf(dp_text(
  134.                     "socket_create(): unable to create socket [%u]: %s\n"),
  135.                     socket_last_error(), socket_strerror(socket_last_error())));
  136.             }
  137.  
  138.             /* Bind the socket to a file, for example /tmp/dutchpipesock */
  139.             if (FALSE === socket_bind($socket, DPSERVER_SOCKET_PATH)) {
  140.                 die(sprintf(dp_text(
  141.                     "socket_bind() unable to bind socket [%u]: %s\n"),
  142.                     socket_last_error(), socket_strerror(socket_last_error())));
  143.             }
  144.             if (FALSE === chmod(DPSERVER_SOCKET_PATH, 0777)) {
  145.                 die(sprintf(dp_text(
  146.                     "Cannot start server: reason: chmod on %s failed\n"),
  147.                     DPSERVER_SOCKET_PATH));
  148.             }
  149.         } elseif (DPSERVER_SOCKET_TYPE === AF_INET) {
  150.             /* Initialize the server, first create a socket */
  151.             if (FALSE === ($socket = socket_create(AF_INET, SOCK_STREAM,
  152.                     SOL_TCP))) {
  153.                 die(sprintf(dp_text(
  154.                     "socket_create(): unable to create socket [%u]: %s\n"),
  155.                     socket_last_error(), socket_strerror(socket_last_error())));
  156.             }
  157.  
  158.             /* Reuse the port in case it was not properly closed */
  159.             socket_set_option($socket, SOL_SOCKET, SO_REUSEADDR, 1);
  160.  
  161.             /* Bind the socket to a file, for example /tmp/dutchpipesock */
  162.             if (FALSE === socket_bind($socket, DPSERVER_SOCKET_ADDRESS,
  163.                     DPSERVER_SOCKET_PORT)) {
  164.                 die(sprintf(dp_text(
  165.                     "socket_bind() unable to bind socket [%u]: %s\n"),
  166.                     socket_last_error(), socket_strerror(socket_last_error())));
  167.             }
  168.         } else {
  169.             die(dp_text("Invalid socket protocol.\n"));
  170.         }
  171.         /* Start listening to the socket which dpclient.php talks to */
  172.         if (FALSE === socket_listen($socket, DPSERVER_MAX_SOCKET_BACKLOG)) {
  173.             die(sprintf(dp_text("socket_listen(): failure [%u]: %s\n"),
  174.                 socket_last_error(), socket_strerror(socket_last_error())));
  175.         }
  176.  
  177.         /* Accept connections and loop for each request */
  178.         do {
  179.             if (FALSE === ($this->mMsgsock = socket_accept($socket))) {
  180.                 echo sprintf(dp_text("socket_accept(): failure [%u]: %s\n"),
  181.                     socket_last_error(), socket_strerror(socket_last_error()));
  182.                 break;
  183.             }
  184.  
  185.             /*
  186.              * We got a connection with a user client through dpclient.php,
  187.              * dpclient.php should send some serialized arrays with variables.
  188.              * These are the PHP global $_SERVER, $_COOKIE, ... arrays.
  189.              * All client info, including input and AJAX parameters, are send
  190.              * through these arrays.
  191.              */
  192.             $allbuf = '';
  193.             do {
  194.                 if (DPSERVER_SOCKET_TYPE === AF_UNIX) {
  195.                     /* Read in what dpclient.php is telling us in chunks */
  196.                     if (FALSE === ($buf = socket_read($this->mMsgsock,
  197.                             DPSERVER_SERVER_CHUNK, PHP_NORMAL_READ))) {
  198.                         echo sprintf(dp_text(
  199.                             "socket_read(): failure [%u]: %s\n"),
  200.                             socket_last_error(),
  201.                             socket_strerror(socket_last_error()));
  202.                         break 2;
  203.                     }
  204.                     if (!dp_strlen($buf = trim($buf))) {
  205.                         continue;
  206.                     }
  207.                     /* This can be used to shutdown the server */
  208.                     if ($buf == 'shutdown') {
  209.                         socket_close($this->mMsgsock);
  210.                         break 2;
  211.                     }
  212.  
  213.                     /*
  214.                      * Read the 2KB blocks until dpclient.php sends us a 'quit'
  215.                      */
  216.                     if ($buf <> 'quit') {
  217.                         $allbuf .= $buf;
  218.                         continue;
  219.                     }
  220.                 } else {
  221.                     /* Read in what dpclient.php is telling us in chunks */
  222.                     if (FALSE === ($buf = socket_read($this->mMsgsock,
  223.                             DPSERVER_SERVER_CHUNK))) {
  224.                         echo sprintf(dp_text(
  225.                             "socket_read(): failure [%u]: %s\n"),
  226.                             socket_last_error(),
  227.                             socket_strerror(socket_last_error()));
  228.                         break 2;
  229.                     }
  230.                     if (!dp_strlen($buf = trim($buf))) {
  231.                         continue;
  232.                     }
  233.                     $allbuf .= $buf;
  234.                     /* This can be used to shutdown the server */
  235.                     if (dp_strlen($allbuf) >= 7 &&
  236.                             dp_substr($allbuf, -7) == 'shutdown') {
  237.                         socket_close($this->mMsgsock);
  238.                         break 2;
  239.                     }
  240.                     /*
  241.                      * Read the 2KB blocks until dpclient.php sends us a 'quit'
  242.                      */
  243.                     if (dp_strlen($allbuf) < 4
  244.                             || dp_substr($allbuf, -4) != 'quit') {
  245.                         continue;
  246.                     }
  247.                     //$allbuf = dp_substr($allbuf, 0, dp_strlen($allbuf - 4));
  248.                 }
  249.  
  250.                 /* Check for invalid input from dpclient.php */
  251.                 if (dp_strlen($allbuf) <= 6
  252.                         || FALSE === ($pos1 = dp_strpos($allbuf, "<vars>"))
  253.                         || FALSE === ($pos2 = dp_strpos($allbuf, "</vars>"))
  254.                         || $pos2 <= $pos1 + 7) {
  255.                     echo 'allbuf: ' . $allbuf . "\n";
  256.                     break;
  257.                 }
  258.  
  259.                 /*
  260.                  * Cut out and unserialize the three global PHP vars
  261.                  * dpclient.php passed on
  262.                  */
  263.                 $vars = dp_substr($allbuf, 0, $pos2);
  264.                 $vars = dp_substr($vars, $pos1 + 6);
  265.                 if (TRUE === DPSERVER_BASE64_CLIENT2SERVER) {
  266.                     $vars = base64_decode($vars);
  267.                 }
  268.                 $tmp = unserialize($vars);
  269.  
  270.                 if (FALSE === $tmp) {
  271.                     //$handle = fopen('/tmp/dpserver.log', 'a');
  272.                     //fwrite($handle, sprintf(dp_text("No unserialize: %s\n"),
  273.                     //$vars));
  274.                     //fclose($handle);
  275.                     echo sprintf(dp_text("No unserialize: %s\n"), $vars);
  276.                     $__SERVER = $__SESSION = $__COOKIE = $__GET = $__POST =
  277.                         $__FILES = array();
  278.                 }
  279.  
  280.                 list($__SERVER, $__SESSION, $__COOKIE, $__GET, $__POST,
  281.                     $__FILES) = $tmp;
  282.                 /*
  283.                  * Pass on the request to the universe object. The universe
  284.                  * object can response by calling tellCurrentDpUserRequest()
  285.                  * below
  286.                  */
  287.                 $universe->handleCurrentDpUserRequest($this, $__SERVER,
  288.                     $__SESSION, $__COOKIE, $__GET, $__POST, $__FILES);
  289.  
  290.                 /*
  291.                  * :KLUDGE: Shows server status once in a while. The ticks
  292.                  * system or external cron triggered calls should be used in the
  293.                  * future
  294.                  */
  295.                 if (1 === mt_rand(1, 2 + $universe->getNrOfUsers())) {
  296.                     $this->_showStatus($universe);
  297.                 }
  298.                 break;
  299.             } while (true);
  300.             socket_close($this->mMsgsock);
  301.         } while (true);
  302.  
  303.         socket_close($sock);
  304.     }
  305.  
  306.     /**
  307.      * Closes the socket when the server is destroyed.
  308.      */
  309.     function __destruct()
  310.     {
  311.         if ($this->mMsgsock) {
  312.             socket_close($this->mMsgsock);
  313.         }
  314.     }
  315.  
  316.     /**
  317.      * Tells a string to the current user request through dpclient.php
  318.      *
  319.      * Called from 'the universe' to talk back to the client, messages are
  320.      * typically XML with something like '<message>Lennert says: hi</message>'.
  321.      *
  322.      * @param       string    $talkback   String to send to current user client
  323.      */
  324.     function tellCurrentDpUserRequest($talkback)
  325.     {
  326.         if (0 === dp_strlen($talkback)) {
  327.             return;
  328.         }
  329.  
  330.         if (TRUE === DPSERVER_BASE64_SERVER2CLIENT) {
  331.             $talkback = base64_encode($talkback);
  332.         }
  333.         $talkback .= chr(0);
  334.  
  335.         if (FALSE === socket_write($this->mMsgsock, $talkback,
  336.                 dp_strlen($talkback))) {
  337.             echo sprintf(dp_text("socket_write(): failure [%u]: %s\n"),
  338.                 socket_last_error(), socket_strerror(socket_last_error()));
  339.         }
  340.     }
  341.  
  342.     /**
  343.      * Shows some server info on the command line
  344.      *
  345.      * @param       object    &$universe  An instance of DpUniverse
  346.      */
  347.     private function _showStatus(&$universe)
  348.     {
  349.         if (DPSERVER_DEBUG_TYPE_MEMORY_GET_USAGE === DPSERVER_DEBUG_TYPE) {
  350.             $universe->showStatusMemoryGetUsage();
  351.         } elseif (DPSERVER_DEBUG_TYPE_GETRUSAGE === DPSERVER_DEBUG_TYPE) {
  352.             $this->_showStatusMemoryGetrusage($universe);
  353.         }
  354.     }
  355.  
  356.     /**
  357.      * Shows a line with getrusage info, see man getrusage
  358.      *
  359.      * @param       object    &$universe  An instance of DpUniverse
  360.      */
  361.     private function _showStatusMemoryGetrusage(&$universe)
  362.     {
  363.         if (!function_exists('getrusage')) {
  364.             return;
  365.         }
  366.  
  367.         $dat = getrusage();
  368.  
  369.         $utime_after = (int)$dat["ru_utime.tv_sec"]*1e6 +
  370.             (int)$dat["ru_utime.tv_usec"];
  371.         $stime_after = (int)$dat["ru_stime.tv_sec"]*1e6 +
  372.             (int)$dat["ru_stime.tv_usec"];
  373.  
  374.         $dat["ru_utime"] = number_format(($utime_after - $this->mUtimeBefore) /
  375.             1000000, 2) . 's';
  376.         $dat["ru_stime"] = number_format(($stime_after - $this->mStimeBefore) /
  377.             1000000, 2) . 's';
  378.         $dat["ru_maxrss"] = $dat["ru_maxrss"] . 'kb';
  379.         unset($dat['ru_oublock']);
  380.         unset($dat['ru_inblock']);
  381.         unset($dat['ru_nswap']);
  382.         unset($dat['ru_nsignals']);
  383.         unset($dat['ru_utime.tv_sec']);
  384.         unset($dat['ru_utime.tv_usec']);
  385.         unset($dat['ru_stime.tv_sec']);
  386.         unset($dat['ru_stime.tv_usec']);
  387.  
  388.         if (0 === (int)$this->mShowedStatusHeader) {
  389.             $keys = array_keys($dat);
  390.             foreach ($keys as $i => $k) {
  391.                 $keys[$i] = dp_substr($keys[$i], 3);
  392.                 if (dp_strlen($keys[$i]) > 7) {
  393.                     $keys[$i] = dp_substr($keys[$i], 0, 7);
  394.                 }
  395.             }
  396.             $this->mShowedStatusHeader = 30;
  397.  
  398.             echo sprintf(dp_text("Memory\t%s\n"), implode("\t", $keys));
  399.         }
  400.  
  401.         echo sprintf(dp_text("%uKB\t%s\n"), round(memory_get_usage() / 1024),
  402.             implode("\t", $dat));
  403.         $this->mShowedStatusHeader--;
  404.     }
  405. }
  406. ?>
Documentation generated on Mon, 03 Sep 2007 22:20:40 +0200 by phpDocumentor 1.3.0RC6

Click me!
Guest#217
 
 
 
  Go to Top
 
 
 Input Field OptionsClose Input Field Go to Top
 
Legal Notices | Copyright © 2006, 2007 Lennert Stock. All rights reserved. Last update: Mon Sep 03 2007, 21:50 CET.