User management for the world wide web

utils.php

<?php
define('TMP_PREFIX','TmG');


class GenieGate_TempWriter {

  var $RH;
  var $WH;
  var $tmp_name;
  var $filename;
  var $working_dir;
  var $cancel;

  function GenieGate_TempWriter($filename){

    // Quickly create one.
    if(! file_exists($filename)){      
      fclose(fopen($filename,"a")) or die("Can't open [$filename]");      
    }

    $this->filename = $filename;
    $this->cancel = FALSE;

    // open and lock file.
    $this->RH = fopen($filename,'r+') or die("Can't open $filename"); // read + write mode, for flock?
    if($this->RH){
      flock($this->RH,LOCK_EX); // Lock file.
      $this->working_dir = dirname($filename); // We'll need this for the tmp file.
      // create & open temp file.
      $this->tmp_name = tempnam($this->working_dir,TMP_PREFIX);
      $this->WH = fopen($this->tmp_name,"w");
    }
  }     
  
  function getFilename(){ return($this->filename()); }
  
  function getRead(){ return($this->RH); }
  function getWrite(){ return($this->WH); }

  function cancel(){
    if(! $this->cancel){
      $this->_close();
      unlink($this->tmp_name);       
      $this->cancel = TRUE;
      if(file_exists($this->tmp_name)){
        unlink($this->tmp_name);
      }
      return(TRUE);
    }
    return(FALSE);
  }  
  function isCanceled(){ return($this->cancel); }

  // Close handles, set them to FALSE.
  function _close(){
     flock($this->RH,LOCK_UN); // Pointless really.
     fclose($this->RH);
     fclose($this->WH);
     $this->WH = FALSE;
     $this->RH = FALSE;
  }
  function complete(){
    if($this->isCanceled()){
      return(FALSE);
    }
    // Preserve file permissions.
    $perm = fileperms($this->filename);
   
    // make sure writing is flushed.
    fflush($this->WH);
    $backup = $this->filename . ".Bck";
    // Create backup, if possible.
    if(rename($this->filename,$backup)){
      if(rename($this->tmp_name,$this->filename)){
    unlink($backup);
    $this->_close();
    chmod($this->filename,$perm);
    return(TRUE);
      }else{
    // Failed to convert backup to 
    error_log("Could not rename [$this->tmp_name] to [$this->filename]");
    rename($backup,$this->filename);    
      }      
    }else{
      // Failed to make the backup copy.
      error_log("Could not rename [$this->filename] to [$backup]");
      unlink($this->tmp_name); 
    }   
    $this->_close();    
    return(FALSE);
  }

}

class GenieGate_XMLWriter {

    var $TAGS = array();
    var $FORMAT = FALSE;

    var $H;

    function GenieGate_XMLWriter($header = TRUE, $format = FALSE){
        $this->FORMAT = $format;       
        if($header){
            $this->out("<?xml version=\"1.0\"?>\n");
        }
    }

    function out($raw){         
        echo $raw;
    }
    function escape($string){
        return(htmlentities($string,ENT_QUOTES));
    }
    function text($string){
        $this->out($this->escape($string));
        if($this->FORMAT){
            $this->out("\n");
        }
    }
    function start($tag,$attr = array()){        
        if($this->FORMAT){
            $tb = str_repeat("\t",count($this->TAGS));
        }
        array_push($this->TAGS,$tag);
        $xml = "$tb<$tag";        

        foreach($attr as $at => $val){
            $xml .= " $at=\"" . $this->escape($val) . "\"";
        }

        $xml .= ">";
        if($this->FORMAT){
            $xml .= "\n";
        }
        $this->out($xml);
    }
    function atom($tag,$attr = array()){
        if($this->FORMAT){
            $tb = str_repeat("\t",count($this->TAGS));
        }
        $xml = "$tb<$tag";
        foreach($attr as $at => $val){
            $xml .= " $at=\"" . $this->escape($val) . "\"";
        }
        $xml .= "/>";
        if($this->FORMAT){
            $xml .= "\n";
        }
        $this->out($xml);
    }
    function close(){
        $str = array_pop($this->TAGS);
        if($this->FORMAT){
            $tb = str_repeat("\t",count($this->TAGS));
            $xml = "$tb</$str>\n";
        }else{
            $xml = "</$str>";
        }
        $this->out($xml);
    }
    function finish(){
        foreach($this->TAGS as $t){
            $this->close();
        }
        $this->out("\n");
    }
}


?>

---

Documentation generated by DoxyGen