: <?php                                                                                       
                 : /**                                                                                         
                 :  * Main class for handling the data to build a page                                         
                 :  *                                                                                          
                 :  * This should be extened for each view required.                                           
                 :  */                                                                                         
                 : class View {                                                                                
                 :   /**                                                                                       
                 :    * @var Error message string                                                              
                 :    */                                                                                       
                 :   public $error_message = '';                                                               
                 :   /**                                                                                       
                 :    * @var Template to use when displaying page                                              
                 :    */                                                                                       
                 :   public $template = '';                                                                    
                 :   /**                                                                                       
                 :    * @var Page title (HTML)                                                                 
                 :    */                                                                                       
                 :   public $title = DEFAULT_TITLE;                                                            
                 :   /**                                                                                       
                 :    * @var View to use when generating page                                                  
                 :    */                                                                                       
                 :   public $view = 'home';                                                                    
                 :                                                                                             
                 :   /**                                                                                       
                 :    * @var Array of style sheets to include                                                  
                 :    */                                                                                       
                 :   protected $css = array('main' => True);                                                   
                 :   /**                                                                                       
                 :    * @var Array of JavaScripts to incluse                                                   
                 :    */                                                                                       
                 :   protected $js = array('main' => True);                                                    
                 :   /**                                                                                       
                 :    * @var HTTP header code                                                                  
                 :    */                                                                                       
                 :   protected $http_header_code = 200;                                                        
                 :   /**                                                                                       
                 :    * @var HTTP content type                                                                 
                 :    */                                                                                       
                 :   protected $http_header_content_type = 'text/html; charset=utf-8';                         
                 :   /**                                                                                       
                 :    * @var Location header - used for 30x redirects                                          
                 :    */                                                                                       
                 :   protected $http_header_location = null;                                                   
                 :   /**                                                                                       
                 :    * @var HTTP code text string hint                                                        
                 :    */                                                                                       
                 :   protected $http_header_string = 'OK';                                                     
                 :   /**                                                                                       
                 :    * @var HTTP headers                                                                      
                 :    */                                                                                       
                 :   protected $http_headers = array();                                                        
                 :                                                                                             
                 :   public function __construct()                                                             
                 :   {                                                                                         
              32 :     $this->view = get_class($this);                                                         
              32 :   }                                                                                         
                 :                                                                                             
                 :   public function preBuild($plugins)                                                        
                 :   {                                                                                         
               1 :     if (is_array($plugins)) {                                                               
               1 :       foreach ($plugins as $plugin) {                                                       
               1 :         $plugin = $plugin.'Plugin';                                                         
               1 :     if (class_exists($plugin)) {                                                            
               1 :           $plugin = new $plugin;                                                            
               1 :           $plugin->preBuild($this);                                                         
               1 :         }                                                                                   
               1 :       }                                                                                     
               1 :       $this->build();                                                                       
               1 :       foreach ($plugins as $plugin) {                                                       
               1 :         $plugin = $plugin.'Plugin';                                                         
               1 :     if (class_exists($plugin)) {                                                            
               1 :           $plugin = new $plugin;                                                            
               1 :           $plugin->postBuild($this);                                                        
               1 :         }                                                                                   
               1 :       }                                                                                     
               1 :     }                                                                                       
               1 :   }                                                                                         
                 :                                                                                             
                 :   /**                                                                                       
                 :    * Main function called before page output                                                
                 :    *                                                                                        
                 :    * Should be overwriden in views.php                                                      
                 :    */                                                                                       
                 :   public function build() {                                                                 
               2 :   }                                                                                         
                 :                                                                                             
                 :   /*/********************** CSS and JS functions *****************************/             
                 :   /**                                                                                       
                 :    * Adds a stylesheet to include                                                           
                 :    *                                                                                        
                 :    * @param $css \p string Name of CSS file without extension                               
                 :    */                                                                                       
                 :   public function add_css($css)                                                             
                 :   {                                                                                         
               1 :     $this->css[$css] = True;                                                                
               1 :   }                                                                                         
                 :   /**                                                                                       
                 :    * Removes a stylesheet to include                                                        
                 :    *                                                                                        
                 :    * @param $css \p string Name of CSS file without extension                               
                 :    */                                                                                       
                 :   public function remove_css($css)                                                          
                 :   {                                                                                         
               2 :     $this->css[$css] = False;                                                               
               2 :   }                                                                                         
                 :   /**                                                                                       
                 :    * Adds an external JavaScript to include                                                 
                 :    *                                                                                        
                 :    * @param $js \p string Name of JS file without extension                                 
                 :    */                                                                                       
                 :   public function add_js($js)                                                               
                 :   {                                                                                         
               1 :     $this->js[$js] = True;                                                                  
               1 :   }                                                                                         
                 :   /**                                                                                       
                 :    * Removes an external JavaScript to include                                              
                 :    *                                                                                        
                 :    * @param $js \p string Name of JS file without extension                                 
                 :    */                                                                                       
                 :   public function remove_js($js)                                                            
                 :   {                                                                                         
               2 :     $this->js[$js] = False;                                                                 
               2 :   }                                                                                         
                 :                                                                                             
                 :   /*/******************* HTTP Header functions ******************************/              
                 :   /**                                                                                       
                 :    * Sets the HTTP status code                                                              
                 :    *                                                                                        
                 :    * @param $code \p int HTTP status code                                                   
                 :    * @param $location \p string Location for redirection                                    
                 :    */                                                                                       
                 :   public function set_HTTP_status_code($code, $location = null)                             
                 :   {                                                                                         
                 :     switch ($code) {                                                                        
              10 :       case 200:                                                                             
               2 :         $this->http_header_string = 'OK';                                                   
               2 :         $this->http_header_code = $code;                                                    
               2 :         $this->http_header_location = null;                                                 
               2 :         break;                                                                              
               9 :       case 301:                                                                             
               1 :         $this->http_header_string = 'Moved Permanently';                                    
               1 :         $this->http_header_code = $code;                                                    
               1 :         $this->http_header_location = $location;                                            
               1 :         break;                                                                              
               8 :       case 302:                                                                             
               1 :         $this->http_header_string = 'Found';                                                
               1 :         $this->http_header_code = $code;                                                    
               1 :         $this->http_header_location = $location;                                            
               1 :         break;                                                                              
               7 :       case 303:                                                                             
               1 :         $this->http_header_string = 'See Other';                                            
               1 :         $this->http_header_code = $code;                                                    
               1 :         $this->http_header_location = $location;                                            
               1 :         break;                                                                              
               6 :       case 307:                                                                             
               3 :         $this->http_header_string = 'Temporary Redirect';                                   
               3 :         $this->http_header_code = $code;                                                    
               3 :         $this->http_header_location = $location;                                            
               3 :         break;                                                                              
               3 :       case 404:                                                                             
               1 :         $this->http_header_string = 'Not Found';                                            
               1 :         $this->http_header_code = $code;                                                    
               1 :         $this->http_header_location = null;                                                 
               1 :         break;                                                                              
               2 :        case 410:                                                                            
               1 :         $this->http_header_string = 'Gone';                                                 
               1 :         $this->http_header_code = $code;                                                    
               1 :         $this->http_header_location = null;                                                 
               1 :         break;                                                                              
               1 :       case 500:                                                                             
               1 :         $this->http_header_string = 'Internal Server Error';                                
               1 :         $this->http_header_code = $code;                                                    
               1 :         $this->http_header_location = null;                                                 
               1 :         break;                                                                              
                 :     }                                                                                       
              10 :   }                                                                                         
                 :   /**                                                                                       
                 :    * Sets the response's mime type                                                          
                 :    *                                                                                        
                 :    * @param $type \p string Mime type of content                                            
                 :    * @param $charset \p string Character set of content                                     
                 :    */                                                                                       
                 :   public function set_content_type($type, $charset = null)                                  
                 :   {                                                                                         
               2 :     $content_type = $type;                                                                  
               2 :     if ($charset) {                                                                         
               1 :       $content_type .= "; charset=$charset";                                                
               1 :     }                                                                                       
               2 :     $this->http_header_content_type = $content_type;                                        
               2 :   }                                                                                         
                 :                                                                                             
                 :   /**                                                                                       
                 :    * Sets a HTTP header, used for non standard headers                                      
                 :    */                                                                                       
                 :   public function set_HTTP_header($header, $value)                                          
                 :   {                                                                                         
               1 :     $this->http_headers[$header] = $value;                                                  
               1 :   }                                                                                         
                 :                                                                                             
                 :   /**                                                                                       
                 :    * Builds the headers as an array                                                         
                 :    *                                                                                        
                 :    * This will be looped over by send_HTTP_headers(), this function is here                 
                 :    * to allow the testing of the headers without calling the header() function              
                 :    * as that function cannot be unit tested.                                                
                 :    *                                                                                        
                 :    * @return \p array List of headers in order, one value per header                        
                 :    */                                                                                       
                 :   protected function build_HTTP_headers()                                                   
                 :   {                                                                                         
               4 :     $return = array();                                                                      
               4 :     if (300 < $this->http_header_code and $this->http_header_code < 400) {                  
                 :       //this is some form of redirect, check we have the correct information                
               2 :       if (strlen($this->http_header_location)) {                                            
               2 :         if (preg_match('/(https?):\/\/([0-9a-zA-Z][-\w]*[0-9a-zA-Z]\.)'.                    
               2 :                        '+[a-zA-Z]{2,9}(:\d{1,4})?([-\w\/#~:.?+=&%@#]*)/',                   
               2 :                        $this->http_header_location)) {                                      
                 :           //the location is a valid URL                                                     
               1 :           $return[1] = sprintf('Location: %s',$this->http_header_location);                 
               1 :         } else {                                                                            
                 :           //there was no valid location so use a 200 code                                   
               1 :           $this->set_HTTP_status_code(200);                                                 
                 :         }                                                                                   
               2 :       }                                                                                     
               2 :     }                                                                                       
               4 :     $return[0] = sprintf('HTTP/1.0 %d %s',                                                  
               4 :                          $this->http_header_code,                                           
               4 :                          $this->http_header_string);                                        
               4 :     if (strlen($this->http_header_content_type)) {                                          
               4 :       $return[2] = sprintf('Content-type: %s', $this->http_header_content_type);            
               4 :     }                                                                                       
               4 :     foreach ($this->http_headers as $code => $value) {                                      
               1 :       $return[] = sprintf('%s: %s', $code, $value);                                         
               4 :     }                                                                                       
               4 :     ksort($return);                                                                         
               4 :     return array_reverse($return); //ensures that the HTTP header gets set last so overrides
                 :   }                                                                                         
                 :                                                                                             
                 :   // @codeCoverageIgnoreStart - can't unit test headers                                     
                 :   /**                                                                                       
                 :    * Sends the HTTP headers, prevents duplication                                           
                 :    */                                                                                       
                 :   public function send_HTTP_headers()                                                       
                 :   {                                                                                         
               0 :     if (False == headers_sent($file, $line)) {                                              
               0 :       foreach ($this->build_HTTP_headers() as $header) {                                    
               0 :         header($header);                                                                    
               0 :       }                                                                                     
               0 :     } else {                                                                                
               0 :       echo $this->debug("Warning:  Headers have already been sent in file ".                
               0 :                         "$file on line $line\n");                                           
                 :     }                                                                                       
               0 :   }                                                                                         
                 :   // @codeCoverageIgnoreEnd                                                                 
                 :                                                                                             
                 :   /**                                                                                       
                 :    * Returns a debug message if DEBUG is set to True                                        
                 :    *                                                                                        
                 :    * @param $string \p string Error message text to display                                 
                 :    *                                                                                        
                 :    * @return \p string Error message for output                                             
                 :    */                                                                                       
                 :   public function debug($string)                                                            
                 :   {                                                                                         
               2 :     $return = '';                                                                           
               2 :     if (DEBUG) {                                                                            
                 :       // @codeCoverageIgnoreStart - can't use two values of a constant                      
               0 :       $return = sprintf('<strong>You are seeing this message  becuase DEBUG '.              
               0 :                         'is set to True in settings.php</strong><br />%s',                  
               0 :                         $string);                                                           
               0 :     }                                                                                       
                 :     // @codeCoverageIgnoreEnd                                                               
               2 :     return $return;                                                                         
                 :   }                                                                                         
                 :                                                                                             
                 :   /*/*************** Template functions used to build page *******************/             
                 :                                                                                             
                 :   /**                                                                                       
                 :    * Retruns the body content via the chosen view                                           
                 :    *                                                                                        
                 :    * @return \p string Body content                                                         
                 :    */                                                                                       
                 :   public function body()                                                                    
                 :   {                                                                                         
               2 :     $page = $this; //make $page available to the template                                   
               2 :     ob_start();                                                                             
               2 :     if (!@include ROOT_DIR."/templates/{$this->view}.php") {                                
               1 :       $this->debug(sprintf("<p>Sorry, the view was not found.<br />".                       
               1 :                            "View requested was: }%s{</p>", $this->view));                   
               1 :     }                                                                                       
               2 :     $return = ob_get_contents();                                                            
               2 :     ob_end_clean();                                                                         
               2 :     return $return;                                                                         
                 :   }                                                                                         
                 :                                                                                             
                 :   /**                                                                                       
                 :    * Returns the page error message via debug                                               
                 :    *                                                                                        
                 :    * @return \p string Error message text                                                   
                 :    */                                                                                       
                 :   public function error_message()                                                           
                 :   {                                                                                         
               1 :     return $this->debug($this->error_message);                                              
                 :   }                                                                                         
                 :                                                                                             
                 :   /**                                                                                       
                 :    * Returns the stylesheets and JavaScript includes                                        
                 :    *                                                                                        
                 :    * @return \p string CSS and JS includes HTML                                             
                 :    */                                                                                       
                 :   public function headers()                                                                 
                 :   {                                                                                         
               3 :     $return = '';                                                                           
               3 :     foreach($this->css as $css => $value) {                                                 
               3 :       if ($value) {                                                                         
               2 :         $return .= sprintf("    <link rel='stylesheet' ".                                   
               2 :                            "href='".WEB_ROOT."/static/%s.css' ".                            
               2 :                            "type='text/css' />\n", $css);                                   
               2 :       }                                                                                     
               3 :     }                                                                                       
               3 :     foreach($this->js as $js => $value) {                                                   
               3 :       if ($value) {                                                                         
               2 :         $return .= sprintf("    <script src='".WEB_ROOT."/static/%s.js' ".                  
               2 :                            "type='text/javascript'></script>\n", $js);                      
               2 :       }                                                                                     
               3 :     }                                                                                       
               3 :     return $return;                                                                         
                 :   }                                                                                         
                 :                                                                                             
                 :   /**                                                                                       
                 :    * Returns the page title                                                                 
                 :    *                                                                                        
                 :    * @return \p string Page Title                                                           
                 :    */                                                                                       
                 :   public function title()                                                                   
                 :   {                                                                                         
               2 :     return sprintf("    <title>%s</title>\n", $this->title) ;                               
                 :   }                                                                                         
                 :                                                                                             
                 :   /**                                                                                       
                 :    * Returns the URI of a route relative to the server root                                 
                 :    *                                                                                        
                 :    * @param $route \p string View to link to, key in the $routes array                      
                 :    *                                                                                        
                 :    * @return \p string URI of route, False if route not found                               
                 :    */                                                                                       
                 :   public function resolve_route($route)                                                     
                 :   {                                                                                         
               6 :     if ($route == 'home') {                                                                 
               2 :       $link = '';                                                                           
               2 :     } else {                                                                                
               4 :       $routes = unserialize(ROUTES); //we need access to the routing table                  
               4 :       $link = array_search($route, $routes);                                                
                 :     }                                                                                       
               6 :     if ($link !== False) {                                                                  
               4 :       $link = sprintf(WEB_ROOT.'/%s', $link);                                               
               4 :     }                                                                                       
               6 :     return $link;                                                                           
                 :   }                                                                                         
                 :                                                                                             
                 :   /**                                                                                       
                 :    * Returns a link to a route                                                              
                 :    *                                                                                        
                 :    * @param $route \p string View to link to, key in the $routes array                      
                 :    * @param $text \p string Link text to display                                            
                 :    * @param $class \p string Class of link                                                  
                 :    * @param $id \p string ID of link                                                        
                 :    * @param $rel \p string Rel attribute of link                                            
                 :    *                                                                                        
                 :    * @return \p string HTML of link to URL of route                                         
                 :    */                                                                                       
                 :   public function link_to_route($route, $text='', $class=null, $id=null, $rel=null)         
                 :   {                                                                                         
               3 :     $link = $this->resolve_route($route);                                                   
               3 :     if ($link !== False) {                                                                  
               2 :       $html = sprintf('<a href="%s"', $link);                                               
               2 :       if ($class) {                                                                         
               2 :         $html .= sprintf(' class="%s"', $class);                                            
               2 :       }                                                                                     
               2 :       if ($id) {                                                                            
               2 :         $html .= sprintf(' id="%s"', $id);                                                  
               2 :       }                                                                                     
               2 :       if ($rel) {                                                                           
               1 :         $html .= sprintf(' rel="%s"', $rel);                                                
               1 :       }                                                                                     
               2 :       $html .= sprintf('>%s</a>', $text);                                                   
               2 :       return $html;                                                                         
                 :     } else {                                                                                
               1 :       return $text;                                                                         
                 :     }                                                                                       
                 :   }                                                                                         
                 : }                                                                                           
                 :                                                                                             
                 : // @codeCoverageIgnoreStart - No point testing these                                        
                 :                                                                                             
                 : /**                                                                                         
                 :  * Preset view class for handling 404 errors                                                
                 :  */                                                                                         
                 : class error404 extends View {                                                               
                 :   public function build()                                                                   
                 :   {                                                                                         
               0 :     $this->title = 'Page not found';                                                        
               0 :     $this->set_HTTP_status_code(404);                                                       
               0 :   }                                                                                         
                 : }                                                                                           
                 : /**                                                                                         
                 :  * Preset view class for handling 500 errors                                                
                 :  */                                                                                         
                 : class error500 extends View {                                                               
                 :   public function build()                                                                   
                 :   {                                                                                         
               0 :     $this->title = 'Internal server error';                                                 
               0 :     $this->set_HTTP_status_code(500);                                                       
               0 :   }                                                                                         
                 : }                                                                                           
                 :                                                                                             
                 : /**                                                                                         
                 :  * Stub for plugins to extend                                                               
                 :  */                                                                                         
                 : class ygPlugin {                                                                            
                 :   public static function preBuild(View $view)                                               
                 :   {                                                                                         
               1 :   }                                                                                         
                 :   public static function postBuild(View $view)                                              
                 :   {                                                                                         
               1 :   }                                                                                         
                 : }