dbscript
[ class tree: dbscript ] [ index: dbscript ] [ all elements ]
Packages:
dbscript

Source for file mapper.php

Documentation is available at mapper.php

  1. <?php
  2.  
  3.   /** 
  4.    * dbscript for PHP 4 & 5 - restful crud framework
  5.    * @version 0.1.2 -- 19-Feb-2007
  6.    * @author Brian Hendrickson <brian@dbscript.net>
  7.    * @link http://dbscript.net/
  8.    * @copyright Copyright 2007 Brian Hendrickson
  9.    * @package dbscript
  10.    * @license http://www.opensource.org/licenses/mit-license.php MIT License
  11.    */
  12.  
  13.   /**
  14.    * URI Mapper
  15.    * 
  16.    * connects the current URI to a Route,
  17.    * establishing the request variable names
  18.    * e.g. my_domain/:resource/:id would map
  19.    * values into $req->resource and $req->id
  20.    * 
  21.    * Usage:
  22.    * <code>
  23.    *   $req = new Mapper();
  24.    * </code>
  25.    * 
  26.    * More info...
  27.    * {@link http://dbscript.net/mapper}
  28.    * 
  29.    * @package dbscript
  30.    * @author Brian Hendrickson <brian@dbscript.net>
  31.    * @access public
  32.    * @return object 
  33.    * @version 0.1.2
  34.    */
  35.  
  36. class Mapper {
  37.   
  38.   /**
  39.    * current URI
  40.    * @var string 
  41.    */
  42.   var $uri;
  43.   
  44.   /**
  45.    * base URI
  46.    * @var string 
  47.    */
  48.   var $base;
  49.  
  50.   /**
  51.    * unmolested regex parts of the URI
  52.    * @var string[] 
  53.    */
  54.   var $values;
  55.   
  56.   /**
  57.    * URI parameter names and values
  58.    * @var string[] 
  59.    */
  60.   var $params;
  61.  
  62.   /**
  63.    * matched Route object
  64.    * @var Route 
  65.    */
  66.   var $activeroute;
  67.  
  68.   /**
  69.    * list of connected Route objects
  70.    * @var Route[] 
  71.    */
  72.   var $routes;
  73.  
  74.   /**
  75.    * list of public methods
  76.    * @var string[] 
  77.    */
  78.   var $allowed_methods;
  79.  
  80.   /**
  81.    * parameters to (silently) propagate
  82.    * @var string[] 
  83.    */
  84.   var $persisted_vars;
  85.  
  86.   /**
  87.    * path to views
  88.    * @var string 
  89.    */
  90.   var $template_path;
  91.   
  92.   /**
  93.    * path to layouts
  94.    * @var string 
  95.    */
  96.   var $layout_path;
  97.   
  98.   /**
  99.    * id of encrypted Cookie owner
  100.    * @var string 
  101.    */
  102.   var $userid;
  103.  
  104.   /**
  105.    * true if an error has been raised
  106.    * @var boolean 
  107.    */
  108.   var $error;
  109.  
  110.   /**
  111.    * contents of error message
  112.    * @var string 
  113.    */
  114.   var $error_string;
  115.   
  116.   /**
  117.    * database Record object for the current session
  118.    * @var string 
  119.    */
  120.   var $DbSession;
  121.  
  122.   function Mapper() {
  123.   
  124.     $this->uri = $this->composite_uri();
  125.     
  126.     preg_match( "/^(https?:\/\/)([^\/]+)\/?[^\?]+?[\??]([\w\/\.]+)?/i", $this->uri, $this->values );
  127.     
  128.     if (!($this->values))
  129.       preg_match( "/^(https?:\/\/)([^\/]+)\/?(([^\?]+))?/i", $this->uri, $this->values );
  130.     
  131.     if ( isset( $this->values[3] ) ) {
  132.       $this->params = explode( '/', $this->values[3] );
  133.     }
  134.     
  135.     $this->base = substr( $this->uri, 0, -1 );
  136.     $this->routes = array();
  137.     $this->persisted_vars = array();
  138.     $this->allowed_methods = array();
  139.     $this->template_path = '';
  140.     $this->layout_path = '';
  141.     $this->error = false;
  142.     $this->userid = 0;
  143.     
  144.   }
  145.     
  146.   function handle_error( $errstr ) {
  147.     $this->error = true;
  148.     $this->params['error'] .= $errstr . "\n";
  149.     trigger_before( 'handle_error', $this, $errstr );
  150.   }
  151.   
  152.   function url_for( $params, $altparams = NULL ) {
  153.     
  154.     $match = false;
  155.     $route_match = NULL;
  156.     
  157.     if ( is_string( $params ) ) {
  158.       // first var is a route name
  159.       $routename = $params;
  160.       $params = $altparams;
  161.     }
  162.     
  163.     foreach ( $this->routes as $r ) {
  164.       
  165.       $vars = array();
  166.       
  167.       foreach ( $r->patterns as $pos => $str ) {
  168.         if ( substr( $str, 0, 1 ) == ':' ) {
  169.           $vars[substr( $str, 1 )] = $pos;
  170.         }
  171.       }
  172.       
  173.       if ( isset( $routename ) ) {
  174.         if ( $routename == $r->name ) {
  175.           // a named route was found
  176.           if ($altparams == NULL)
  177.             $params = $r->defaults;
  178.           return $r->build_url( $params, $this->base );
  179.         }
  180.       } elseif ( count( array_intersect( array_keys($vars), array_keys($params) ) ) == count( $vars ) && count($vars) == count($params) ) {
  181.         // every pattern in the route exists in the requested params
  182.         
  183.         return $r->build_url( $params, $this->base );
  184.       } else {
  185.         // eh
  186.       }
  187.       
  188.     }
  189.     
  190.     foreach ( $this->params as $paramkey=>$paramval ) {
  191.       
  192.       if ( is_integer( $paramkey ) )
  193.         continue;
  194.       
  195.       $params[$paramkey] = $paramval;
  196.       
  197.       foreach ( $this->routes as $r ) {
  198.         
  199.         $vars = array();
  200.         
  201.         foreach ( $r->patterns as $pos => $str ) {
  202.           if ( substr( $str, 0, 1 ) == ':' ) {
  203.             $vars[substr( $str, 1 )] = $pos;
  204.           }
  205.         }
  206.         
  207.         if ( count( array_intersect( array_keys($vars), array_keys($params) ) ) == count( $vars ) && count($vars) == count($params) ) {
  208.           return $r->build_url( $params, $this->base );
  209.         }
  210.       
  211.       } // end foreach routes
  212.     
  213.     } // end foreach params
  214.  
  215.   }
  216.   
  217.   function link_to( $params, $altparams = NULL ) {
  218.     $url = $this->url_for( $params, $altparams );
  219.     return "<a href=\"$url\">$url</a>";
  220.   }
  221.   
  222.   function redirect_to( $params, $altparams = NULL ) {
  223.     header( "Location: " . $this->url_for($params, $altparams) );
  224.   }
  225.  
  226.   function breadcrumbs() {
  227.     $controller = $this->params['resource'];
  228.     $links = array();
  229.     $html = "";
  230.  
  231.     $links[] = '<a href="'. $this->base .'">Contents</a>';
  232.     
  233.     if ( isset( $this->resource ) && ( $this->resource != 'introspection' ))
  234.       $links[] = '<a href="'. $this->base .'?'.$this->resource.'">'.ucwords($this->resource).'</a>';
  235.     
  236.     if ( ($this->id != 0) && isset( $this->resource ) && ( $this->resource != 'introspection' ))
  237.        $links[] = '<a href="'.$this->entry_url($this->id).'">Entry '.ucwords($this->id).'</a>';
  238.     elseif ( isset( $this->resource )  && $this->new_url())
  239.       $links[] = '<a href="'.$this->new_url().'">New '.classify($this->resource).'</a>';
  240.     
  241.     $html = "<span>";
  242.     foreach ($links as $key=>$val) {
  243.       if ($key > 0) {
  244.         $html .= " | ";
  245.       }
  246.       $html .= $val;
  247.     }
  248.     $html .= "</span>";
  249.     return $html;
  250.   }
  251.   
  252.   function set_persisted_vars($arr) {
  253.     if (is_array($arr))
  254.       $this->persisted_vars = $arr;
  255.   }
  256.   
  257.   function set_filter( $name, $func, $when = 'after' ) {
  258.     aspect_join_functions( $func, $name, $when );
  259.   }
  260.   
  261.   function set_action( $method ) {
  262.     $this->allowed_methods[] = $method;
  263.   }
  264.   
  265.   function set_param( $param, $value ) {
  266.     $this->params[$param] = $value;
  267.     if (!isset($this->$param))
  268.       $this->$param =& $this->params[$param];
  269.   }
  270.   
  271.   function set_layout_path( $path ) {
  272.     $this->layout_path = $path;
  273.   }
  274.     
  275.   function set_template_path( $path ) {
  276.     $this->template_path = $path;
  277.   }
  278.   
  279.   function feed_url() {
  280.     $result = false;
  281.     if (isset($this->resource))
  282.       $result = is_file( $this->template_path . $this->resource . DIRECTORY_SEPARATOR. '_index.atom' );
  283.     if ($result)
  284.       return $this->url_for( array('resource'=>$this->resource, 'action'=>'index.atom'));
  285.     return $result;
  286.   }
  287.   
  288.   function entry_url( $id = NULL ) {
  289.     $result = false;
  290.     if (isset($this->resource))
  291.       $result = is_file( $this->template_path . $this->resource . DIRECTORY_SEPARATOR. '_entry.xhtml' );
  292.     if (!$result)
  293.       $result = is_file( $this->template_path . $this->resource . DIRECTORY_SEPARATOR. '_entry.html' );
  294.     if ($result && ($id != NULL))
  295.       return $this->url_for( array('resource'=>$this->resource, 'action'=>'entry', 'id'=>$id));
  296.     if ($result)
  297.       return $this->url_for( array('resource'=>$this->resource, 'action'=>'entry'));
  298.     return $result;
  299.   }
  300.   
  301.   function new_url() {
  302.     $result = false;
  303.     if (isset($this->resource))
  304.       $result = is_file( $this->template_path . $this->resource . DIRECTORY_SEPARATOR. '_new.xhtml' );
  305.     if (!$result)
  306.       $result = is_file( $this->template_path . $this->resource . DIRECTORY_SEPARATOR. '_new.html' );
  307.     if ($result)
  308.       return $this->url_for( array('resource'=>$this->resource, 'action'=>'new'));
  309.     return $result;
  310.   }
  311.     
  312.   function get_template_path( $ext, $template = null ) {
  313.     
  314.     if (isset($this->params['resource']))
  315.       $resource = $this->params['resource'] . DIRECTORY_SEPARATOR;
  316.     else
  317.       $resource = "";
  318.     
  319.     if ($template == null) {
  320.       $partial = false;
  321.       $template = $this->params['action'];
  322.     } else {
  323.       $partial = true;
  324.       $template = "_" . $template;
  325.     }
  326.     
  327.     if ($template == 'get')
  328.       $template = 'index';
  329.     
  330.     if (isset($this->params['client_wants']))
  331.       $ext = $this->params['client_wants'];
  332.     
  333.     $view = $this->template_path . $resource . $template . "." . $ext;
  334.     
  335.     if (!(is_file($view)))
  336.       $view = $this->template_path . $template . "." . $ext;
  337.     
  338.     if (!$partial && !(is_file($view)))
  339.       $view = $this->template_path . $resource . 'index' . "." . $ext;
  340.     
  341.     if (!$partial && !(is_file($view)))
  342.       $view = $this->template_path . 'index' . "." . $ext;
  343.     
  344.     if (is_file($view))
  345.       return $view;
  346.     else
  347.       return false;
  348.     
  349.   }
  350.   
  351.   function is_allowed( $method ) {
  352.     return in_array( $method, $this->allowed_methods, true );
  353.   }
  354.   
  355.   function connect() {
  356.     // Create and connect a new Route to the Mapper
  357.     
  358.     $r = new Route();
  359.     
  360.     $args = func_get_args();
  361.     
  362.     foreach ( $args as $idx => $arg ) {
  363.       
  364.       if ( is_string( $arg ) ) {
  365.         
  366.         $r->patterns = explode( '/', $arg );
  367.         if ( count( $r->patterns ) == 1 && $idx == 0 ) {
  368.           $r->name = $r->patterns[0];
  369.         }
  370.         
  371.       } elseif ( is_array( $arg ) ) {
  372.         
  373.         foreach ( $arg as $key => $val ) {
  374.           if ( $key == 'requirements' ) {
  375.             $i = 0;
  376.             foreach ( $r->patterns as $pos => $str ) {
  377.               if ( substr( $str, 0, 1 ) == ':' ) {
  378.                 $r->requirements[$pos] = $val[$i];
  379.                 $i++;
  380.               }
  381.             }
  382.           } else {
  383.             $r->defaults[$key] = $val;
  384.           }
  385.         }
  386.         
  387.       }
  388.       
  389.     }
  390.     
  391.     $this->routes[] = $r;
  392.     
  393.   }
  394.   
  395.   function generate( $controller='index.php', $action='get' ) {
  396.     // Generate a route from a set of keywords and return the url
  397.   }
  398.   
  399.   function routematch( $url = NULL ) {
  400.     // Match a URL against against one of the routes contained.
  401.     $return = false;
  402.     trigger_before( 'routematch', $this, $this->activeroute );
  403.     
  404.     if ($url === NULL) $url = $this->uri;
  405.     
  406.     foreach ( $this->routes as $route ) {
  407.       if ($this->match( $url, $route )) {
  408.         break;
  409.         $return = true;
  410.       }
  411.     }
  412.     
  413.     if ( isset( $this->params['method'] ) ) $this->action = $this->method;
  414.     
  415.     if ( isset( $this->params['forward_to'] ) ) $this->controller = $this->forward_to;
  416.     
  417.     if (!(strpos($this->action,".") === false)) { // check for period
  418.       $actionsplit = split("\.", $this->action);
  419.       $this->set_param( 'action', $actionsplit[0]);
  420.       $this->set_param( 'client_wants', $actionsplit[1] );
  421.     }
  422.     #print $this->resource; exit;
  423.     if (isset($this->resource)) {
  424.       if (!(strpos($this->resource,".") === false)) { // check for period
  425.         $actionsplit = split("\.", $this->resource);
  426.         $this->set_param( 'resource', $actionsplit[0]);
  427.         $this->set_param( 'client_wants', $actionsplit[1] );
  428.       }
  429.     }
  430.     
  431.     trigger_after( 'routematch', $this, $this->activeroute );
  432.     
  433.     return $return;
  434.     
  435.   }
  436.   
  437.   function match( $url, $r ) {
  438.     
  439.     foreach ( $r->patterns as $idx => $value ) {
  440.       if ( !( isset( $this->params[$idx] ) ) ) {
  441.         return false;
  442.       }
  443.     }
  444.     
  445.     $i = 0;
  446.     $regx = array();
  447.     foreach ( $r->patterns as $pos => $str ) {
  448.       if ( substr( $str, 0, 1 ) == ':' ) {
  449.         if ( isset( $r->requirements[$pos] ) ) {
  450.           $regx[] = $r->requirements[$pos];
  451.         } else {
  452.           $regx[] = '(.+)';
  453.         }
  454.         $i++;
  455.       } else {
  456.         $regx[] = $str;
  457.       }
  458.     }
  459.     
  460.     $params = $this->params;
  461.     
  462.     while ( count( $params ) > count( $regx ) ) {
  463.       array_shift( $params );
  464.     }
  465.     
  466.     #print "searching for ". "/\/" . implode( "\/", $regx ) . "/i". " in the string /" .implode( "/", $params )."<br><br>";
  467.     
  468.     if ( count( $r->patterns ) == 0 ) {
  469.       $r->match = true;
  470.       $pmatches = array();
  471.     } elseif ( preg_match( "/\/" . implode( "\/", $regx ) . "/i", "/" .implode( "/", $params ), $pmatches ) ) {
  472.       $this->base = substr( $this->uri, 0, -strlen($pmatches[0]));
  473.       $r->match = true;
  474.     }
  475.     
  476.     if ($r->match) {
  477.       $this->activeroute =& $r;
  478.       $this->params = array_merge( $_GET, $_POST, $r->defaults, $this->params );
  479.       foreach ( $this->params as $p=>$v ) {
  480.         if ( !( isset( $this->$p ) ) )
  481.           $this->$p =& $this->params[$p];
  482.       }
  483.       foreach ( $r->patterns as $idx => $val ) {
  484.         if ( substr( $val, 0, 1 ) == ':' ) {
  485.           $val = substr( $val, 1);
  486.           if ( isset( $params[$idx] ) ) $this->params[$val] = $params[$idx];
  487.         }
  488.       }
  489.       
  490.     }
  491.     return $r->match;
  492.   }
  493.   
  494.   function composite_uri() {
  495.     // cross platform URI code by Angsuman Chakraborty
  496.     $port = "";
  497.     if ( isset( $_SERVER['HTTPS'] ) && $_SERVER['HTTPS']=='on' ) {
  498.       $_SERVER['FULL_URL'] = 'https://';
  499.       if ( $_SERVER['SERVER_PORT']!='443' ) {
  500.         $port = ':' . $_SERVER['SERVER_PORT'];
  501.       }
  502.     } else {
  503.       $_SERVER['FULL_URL'] = 'http://';
  504.       if ( $_SERVER['SERVER_PORT']!='80' ) {
  505.         $port = ':' . $_SERVER['SERVER_PORT'];
  506.       }
  507.     }
  508.     if ( isset( $_SERVER['REQUEST_URI'] ) ) {
  509.       $script = $_SERVER['REQUEST_URI'];
  510.     } else {
  511.       $script = $_SERVER['PHP_SELF'];
  512.       if ( $_SERVER['QUERY_STRING']>' ' ) {
  513.         $script .= '?'.$_SERVER['QUERY_STRING'];
  514.       }
  515.     }
  516.     if ( isset( $_SERVER['HTTP_HOST'] ) ) {
  517.       $_SERVER['FULL_URL'] .= $_SERVER['HTTP_HOST'] . $port . $script;
  518.     } else {
  519.       $_SERVER['FULL_URL'] .= $_SERVER['SERVER_NAME'] . $port . $script;
  520.     }
  521.     return $_SERVER['FULL_URL'];
  522.   }
  523.   
  524.   function hasErrors() {
  525.     if ( $this->error === true )
  526.       return true;
  527.     return false;
  528.   }
  529.   
  530.   function propagate() {
  531.     $allowed = $this->persisted_vars;
  532.     $_SESSION['params'] = array();
  533.     foreach( $this->params as $param=>$val ) {
  534.       if (in_array($param, $allowed)) {
  535.         $_SESSION['params'][$param] = $val;
  536.       }
  537.     }
  538.   }
  539.   
  540.   function restore() {
  541.     if (!(isset($_SESSION['params']))) return false;
  542.     foreach( $_SESSION['params'] as $param=>$val ) {
  543.       $this->params[$param] = $val;
  544.       $this->$param =& $this->params[$param];
  545.     }
  546.   }
  547.   
  548. }
  549.  
  550. ?>
Documentation generated on Mon, 19 Feb 2007 10:24:47 -0800 by phpDocumentor 1.3.1