<?php
/*  $get_pageversion(): /inc/function_get_pageversion.php v.2.01 2003/09/25 15:00:22 NkM Exp$
 *
 *  Usage: array get_pageversion(adodb resource link);
 *
 *  This function will return an array with last modification date and version.  
 *  The input function for this file must be the resource link for the notes
 *  database.
 *
 *  adodb is required for this to work.  You need to pass your $ADO connection over.
 *  adodb.inc.php should be included before this function.
 *  Visit http://php.weblogs.com/ADODB for more information on how to setup a connection.
 *
 *  Create a table with this structure in your database...

# MySQL
CREATE TABLE sys_pageversion_log (
  file_name varchar(128) NOT NULL default '',
  file_version varchar(8) default NULL,
  last_update int(11) default NULL,
  last_maintainer varchar(128) default NULL,
  last_email varchar(128) default NULL,
  count int(10) default NULL,
  PRIMARY KEY  (file_name)
);

# PostgreSQL
CREATE TABLE sys_pageversion_log (
  file_name varchar(128) NOT NULL PRIMARY KEY,
  file_version varchar(8), 
  last_update int4, 
  last_maintainer varchar(128), 
  last_email varchar(128), 
  count int4);
COMMENT ON TABLE sys_pageversion_log IS 'Page Versions.';

 *  What does this function return in the array?
 *  $stuff['version'] <- The version of the page
 *  $stuff['mdate'] <- Last modified date for the file.
 *  $stuff['uri'] <- The URI of the accessed file.
 *  $stuff['file'] <- The name of the file itself.
 *
 *  Optional returns in the array for $COUNTER_ON 
 *  $stuff['count'] <- Number of visits per session.
 *
 *  Optional returns in the array fro $DREAMWEAVER_LCK_ON
 *  $stuff['modify_by'] <- Bool value, Let's you know who currently checked in the file (.LCK)
 *  $stuff['check_name'] <- Last .LCK file read from the database, or if .LCK file exists, current .LCK file of the name of the maintainer
 *  $stuff['check_email'] <- Ditto from above, except it's the email address. 
 *
 *  It's best to echo each of the contents to get an idea.
 *
 *  Designer's Notes:  After the Dreamweaver implementation, this is the ugliest thing I've ever written.
 *  The Dreamweaver .LCK files aren't reliable for checking who was the last person who modified it
 *  because a visitor needs to hit the change after a user updated it.  This registers the last .LCK
 *  of the Check In/Check Out system.  
 *
 *  Once the user does a Check Out on the file in Dreamweaver, the .LCK file is gone (locally and on server) 
 *  Confused?  So am I.  Take this scenerio.  I'm the designer of the webpage and you are the visitor...
 *
 *  I Check Out a file to work on in Dreamweaver, the .LCK file exists both locally and on server.  I haven't
 *  updated the file I Checked Out, but if you visit my page, the .LCK file says I'm the current maintainer.
 *  The last modified file times don't reflect that change since I haven't updated my modified file to the
 *  server.  
 *
 *  The $stuff['modify_by'] flags are there to help determine who is currenlty modifying the page... there's
 *  a .LCK out (flag set true).  You say "current modified by" instead of "last modified by" since the last modify
 *  file date and whoever currently Checked Out the file may not be correct.
 *
 *  This is a neat hack on keeping tabs on who changes what.  I'm sure a real function/program is already out
 *  there that keeps tabs on HTML pages.  It's CVS-like, and I think it's called WebDAV.  I can't get WebDAV
 *  working on my server (not that much help info on it).  But don't depend on the Dreamweaver part of this
 *  function to keep tabs on who modified what.
 *
 *  A sure fire work around that the last modified file fits the last modified maintainer.  Have the
 *  the maintainer visit that page on the website to trigger the function.  This is something I normally do
 *  since Dreamweaver "preview" is a bit cumbersome, and I rather just connect to my server and view
 *  my latest changes.
 *
 *  If all else false, don't turn on the $DREAMWEAVER_LCK_ON option and everything will be Kosher.
 */

function get_pageversion($ADO)
{   
  /* Declare a couple of local variables */
  $TABLE = 'sys_pageversion_log'; // Name of table in DB
  $INITIAL_VERSION = '0.01'; // Should be a string
  $INCREMENTAL_VERSION = 0.01; // Should be a float
  
  /* The following are optional, default is false for both */
  $COUNTER_ON = true; // bool value, either true or false
  $DREAMWEAVER_LCK_ON = false; // bool value, either true or false
  
  $self = $_SERVER['PHP_SELF'];
  $uri = $_SERVER['REQUEST_URI'];
  
  /* Retrieve file name */
  $stuff['file'] = array_pop(explode('/', $self));
  
  /* Designate .LCK file */
  $lck_file = $stuff['file'] . '.LCK';
  
  /* Get modify timestamp for file */
  $current_timestamp = filemtime($stuff['file']);

  
  /* Check for last modification date on the database by retrieving correct listing */  
  /* 2003/08/08 -- 1.xx version, phase out *//*
  $sql_select_log = "SELECT * FROM " . $TABLE . " WHERE file_name = '" . $self . "'";
  $results_select_log = mysql_query($sql_select_log, $ADO) or die(mysql_error());
  $numrows_select_log = mysql_num_rows($results_select_log);*/
  $sql_select_log = "SELECT * FROM " . $TABLE . " WHERE file_name = '" . $self . "'";
  $rs_select_log = $ADO->Execute($sql_select_log);
  $numrows_select_log = $rs_select_log->RecordCount();

  
  /* If page found, check for modification time, otherwise insert the new page in the database */
  if ($numrows_select_log > 0)
  {
    /* Page found in table, ready processing */
	/* 2003/08/08 -- 1.xx version, phase out *//*
    $row_select_log = mysql_fetch_assoc($results_select_log);*/
	
	/* Update count */
	/* 2003/08/08 -- 1.xx version, phase out *//*
	$count = $row_select_log['count'] + 1;*/
	$count = ($rs_select_log->fields['count'] + 1);
		
	/* 2003/08/08 -- 1.xx version, phase out *//*
	if ($current_timestamp > $row_select_log['last_update'])*/
	if ($current_timestamp > $rs_select_log->fields['last_update'])
	{
	  /* Current timestamp is greater, update it */
	  /* 2003/08/08 -- 1.xx version, phase out *//*
	  $version = ($row_select_log['file_version'] + $INCREMENTAL_VERSION);*/
	  $version = ($rs_select_log->fields['file_version'] + $INCREMENTAL_VERSION);
	  
	  /* 2003/08/08 -- 2.xx version includes autogenerated UPDATE and INSERT sql statements */
	  $prep_sql_update_log = "SELECT * FROM " . $TABLE . " WHERE file_name = '" . $self . "'";
	  $prep_rs_update_log = $ADO->Execute($prep_sql_update_log);
	  $prep_rec_update_log = array();
	  
	  if ($DREAMWEAVER_LCK_ON)
	  {
	    /* Update page with respective existing .LCK files */
		if ($lck_file_ptr = @file($lck_file))
		{
		  /* .LCK file exists! */
		  $lck_parts = explode('|', $lck_file_ptr[0]);

		  /* 2003/08/08 -- 1.xx version, phase out *//*
	      $sql_update_log = "UPDATE " . $TABLE . " SET file_version = '" . $version . "', last_update = '" . $current_timestamp . "', last_maintainer = '" . addslashes($lck_parts[0]) . "', last_email = '" . addslashes($lck_parts[2]) . "' WHERE file_name = '" . $self . "'";*/
		  $prep_rec_update_log['file_version'] = $version;
		  $prep_rec_update_log['last_update'] = $current_timestamp;
		  $prep_rec_update_log['last_maintainer'] = $lck_parts[0];
		  $prep_rec_update_log['last_email'] = $lck_parts[2];

		  $check_name = $lck_parts[0];
		  $check_email = $lck_parts[2];
		  $stuff['modify_by'] = true;
		}
		else
		{
		  /* .LCK file doesn't exist! */
		  /* 2003/08/08 -- 1.xx version, phase out *//*
		  $sql_update_log = "UPDATE " . $TABLE . " SET file_version = '" . $version . "', last_update = '" . $current_timestamp . "' WHERE file_name='" . $self . "'";*/
		  $prep_rec_update_log['file_version'] = $version;
		  $prep_rec_update_log['last_update'] = $current_timestamp;
		  
		  /* 2003/08/08 -- 1.xx version, phase out *//*
		  $check_name = stripslashes($row_select_log['last_maintainer']);
		  $check_email = stripslashes($row_select_log['last_email']);*/
		  $check_name = $rs_select_log->fields['last_maintainer'];
		  $check_email = $rs_select_log->fields['last_email'];
		  $stuff['modify_by'] = false;
		}
		
		/* 2003/08/08 -- 1.xx version, phase out *//*
	    mysql_query($sql_update_log, $ADO) or die(mysql_error());*/
		$sql_update_log = $ADO->GetUpdateSQL($prep_rs_update_log, $prep_rec_update_log);
		$ADO->Execute($sql_update_log);
	  }
	  else
	  {
	    /* Update page without .LCK files */
		/* 2003/08/08 -- 1.xx version, phase out *//*
	    $sql_update_log = "UPDATE " . $TABLE . " SET file_version = '" . $version . "', last_update = '" . $current_timestamp . "' WHERE file_name='" . $self . "'";*/
		$prep_rec_update_log['file_version'] = $version;
		$prep_rec_update_log['last_update'] = $current_timestamp;
		
		/* 2003/08/08 -- 1.xx version, phase out *//*
	    mysql_query($sql_update_log, $ADO) or die(mysql_error());*/
		$sql_update_log = $ADO->GetUpdateSQL($prep_rs_update_log, $prep_rec_update_log);
		$ADO->Execute($sql_update_log);
	  }
	}
	else
	{
	  /* Current timestamp is not greater, retrieve file version */
	  /* 2003/08/08 -- 1.xx version, phase out *//*
	  $version = $row_select_log['file_version'];
	  $check_name = stripslashes($row_select_log['last_maintainer']);
	  $check_email = stripslashes($row_select_log['last_email']);*/
	  $version = $rs_select_log->fields['file_version'];
	  $check_name = $rs_select_log->fields['last_maintainer'];
	  $check_email = $rs_select_log->fields['last_email'];
	  
	}
  }
  else
  {
    /* 2003/08/08 -- 2.xx version includes autogenerated UPDATE and INSERT sql statements */
	$prep_sql_insert_log = "SELECT * FROM " . $TABLE . " WHERE file_name = '-1'";
	$prep_rs_insert_log = $ADO->Execute($prep_sql_insert_log);
	$prep_rec_insert_log = array();
	
    /* Page not found in table, insert it */
    $version = $INITIAL_VERSION;
	$count = 1;
	
	if ($DREAMWEAVER_LCK_ON)
	{
	  /* Insert with .LCK files */
	  if ($lck_file_ptr = @file($lck_file))
	  {
	    /* .LCK file exists! */
		$lck_parts = explode('|', $lck_file_ptr[0]);
		
		/* 2003/08/08 -- 1.xx version, phase out *//*
	    $sql_insert_log = "INSERT INTO " . $TABLE . " (file_name, file_version, last_update, last_maintainer, last_email, count) 
		  VALUES ('" . $self . "', '" . $version . "', '" . $current_timestamp . "', '" . addslashes($lck_parts[0]) . "', '" . addslashes($lck_parts[2]) . "', '" . $count . "')";*/
		$prep_rec_insert_log['file_name'] = $self;
		$prep_rec_insert_log['file_version'] = $version;
		$prep_rec_insert_log['last_update'] = $current_timestamp;
		$prep_rec_insert_log['last_maintainer'] = $lck_parts[0];
		$prep_rec_insert_log['last_email'] = $lck_parts[2];
		$prep_rec_insert_log['count'] = $count;
		
		$check_name = $lck_parts[0];
  	    $check_email = $lck_parts[2];		
		$stuff['modify_by'] = true;
	  }
	  else
	  {
	    /* .LCK file doesn't exist! */
		
		/* 2003/08/08 -- 1.xx version, phase out *//*
	    $sql_insert_log = "INSERT INTO " . $TABLE . " (file_name, file_version, last_update, last_maintainer, last_email, count) 
		  VALUES ('" . $self . "', '" . $version . "', '" . $current_timestamp . "', '', '', '" . $count . "')";*/
		
		$prep_rec_insert_log['file_name'] = $self;
		$prep_rec_insert_log['file_version'] = $version;
		$prep_rec_insert_log['last_update'] = $current_timestamp;
		$prep_rec_insert_log['last_maintainer'] = '';
		$prep_rec_insert_log['last_email'] = '';
		$prep_rec_insert_log['count'] = $count;
		
		$check_name = '';
		$check_email = '';		
		$stuff['modify_by'] = false;
	  }	  
	}
	else
	{
	  /* Insert without .LCK files */
	  /* 2003/08/08 -- 1.xx version, phase out *//*
	  $sql_insert_log = "INSERT INTO " . $TABLE . " (file_name, file_version, last_update, last_maintainer, last_email, count) 
	    VALUES ('" . $self . "', '" . $version . "', '" . $current_timestamp . "', '', '', '" . $count . "')";*/
	  
	  $prep_rec_insert_log['file_name'] = $self;
	  $prep_rec_insert_log['file_version'] = $version;
	  $prep_rec_insert_log['last_update'] = $current_timestamp;
	  $prep_rec_insert_log['last_maintainer'] = '';
	  $prep_rec_insert_log['last_email'] = '';
	  $prep_rec_insert_log['count'] = $count;
	}
    /* 2003/08/08 -- 1.xx version, phase out *//*
	mysql_query($sql_insert_log, $ADO) or die(mysql_error());*/
	
	$sql_insert_log = $ADO->GetInsertSQL($prep_rs_insert_log, $prep_rec_insert_log);
	$ADO->Execute($sql_insert_log);
  }


  if ($DREAMWEAVER_LCK_ON)
  {
    /* Finally, $stuff['modify_by'] determines state of the page */
    if ($stuff['modify_by'])
    {
      /* File is checked out by user, pass back current check information */
	  $stuff['check_name'] = $lck_parts[0];
	  $stuff['check_email'] = $lck_parts[2];
    }
    else
    {
      /* File is checked in by user, pass back last checked in information */
	  $stuff['check_name'] = $check_name;
	  $stuff['check_email'] = $check_email;
	}
  }
  
  
  /* Set version ready for return */
  $stuff['version'] = $version;
  
  /* Retrieve last modified time and format date */
  $stuff['mdate'] = date('Y/m/d H:i:s T', filemtime($stuff['file']));
  
  /* Send the page URI without any query strings */
  $sort_uri = explode('?', $uri);
  $stuff['uri'] = $sort_uri[0]; 
  
  /* Only run counter if it's on */
  if ($COUNTER_ON)
  {
    /* Only update count if user has never been here */
    $page_id = md5($self);
    if (! $_SESSION['get_pageversion_counted'][$page_id])
    {
      $_SESSION['get_pageversion_counted'][$page_id] = true;
	
	  /* 2003/08/08 -- 1.xx version, phase out *//*
	  $sql_update_count = "UPDATE " . $TABLE . " SET count = '" . $count . "' WHERE file_name = '" . $self . "'";*/
	  $prep_sql_update_count = "SELECT * FROM " . $TABLE . " WHERE file_name = '" . $self . "'";
	  $prep_rs_update_count = $ADO->Execute($prep_sql_update_count);
	  $prep_rec_update_count = array();
	  
	  $prep_rec_update_count['count'] = $count;
	  
	  /* 2003/08/08 -- 1.xx version, phase out *//*
	  mysql_query($sql_update_count, $ADO) or die(mysql_error());*/
	  $sql_update_count = $ADO->GetUpdateSQL($prep_rs_update_count, $prep_rec_update_count);
	  $ADO->Execute($sql_update_count);
	
	  $stuff['count'] = $count;
    }
    else
    {
	  /* 2003/09/25 -- 1.xx version, phase out *//*
      $stuff['count'] = $row_select_log['count'];*/ 
	  $stuff['count'] = $rs_select_log->fields['count'];
    }  
  }
  

  /* Return results */
  return $stuff;
} 
?>