root/trunk/midgard/tools/midrepository/DataflowMidgardVC.php

<?php
// +----------------------------------------------------------------------+
// | MidRepository: Version Control                                       |
// +----------------------------------------------------------------------+
// | Copyright (c) 2003 David Schmitter, Dataflow Solutions GmbH          |
// +----------------------------------------------------------------------+
// | This program is free software; you can redistribute it and/or modify |
// | it under the terms of the GNU General Public License as published    |
// | by the Free Software Foundation; either version 2 of the License,    |
// | or (at your option) any later version.                               |
// |                                                                      |
// | This program is distributed in the hope that it will be useful,      |
// | but WITHOUT ANY WARRANTY; without even the implied warranty of       |
// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        |
// | GNU General Public License for more details.                         |
// |                                                                      |
// | You should have received a copy of the GNU General Public License    |
// | along with this program; if not, write to the Free Software          |
// | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, |
// | USA                                                                  |
// +----------------------------------------------------------------------+
// | Author: David Schmitter <schmitt@dataflow.ch>                        |
// +----------------------------------------------------------------------+
//

if (DEBUG) {
  ini_set("error_reporting", E_ALL);
} 

define('MGD_ERR_ERROR', 0);
define('MGD_ERR_ACCESS_DENIED', 0);
define('MGD_ERR_LOCK', 0);
define('MGD_ERR_NOT_EXISTS', 0);
define('MGD_ERR_NOT_DEFINED', 0);
define('MGD_ERR_NOT_IMPLEMENTED', 0);

define('PART_REVISION_TABLE', 'part_branch_revision');
define('PART_TABLE', 'part_branch');
define('DEEP_COLLECTION_TABLE', 'collection');

define('PART_CURRENT', 1);
define('PART_NEW_DB', 2);
define('PART_NEW_CVS', 3);
define('PART_NEW_CVS_FROM_WF', 4);
define('PART_AUTO', 5);
define('PART_UPDATE', 6);
define('PART_MISSING_DEP', 7);
define('PART_MISSING_DEP_FROM_WF', 8);

define('DB_USER', 1);
define('MGD_USER', 2);
define('SPECIFY_USER', 3);

require_once 'lib/paths.php';
require_once 'lib/common.php';
require_once 'DB.php';

$i18nTables = array('article', 'element', 'page', 'pageelement', 'snippet');

PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, 'handle_pear_error');

$GLOBALS['PartLocks'] = array();


/**
 * Global registry for MgdPart locks. On $MgdPart->lock() a unique identifier is placed here and later read to determine if the current script is the locker.
 */
class PartLockRegistry {
  /** 
   * Adds a lock for a given PartBranchId.
   * @param int $pdId 
   * @param string $uniqId
   */
  function addLock($pbId, $uniqId) {
    $GLOBALS['PartLocks'][$pbId] = $uniqId;
  }
  
  /** 
   * Gets unique-lock-id for a given PartBranchId, if present
   * @param int $pdId 
   * @return mixed $uniqId the lock id, or false if not present
   */
  function getLock($pbId) {
    if (isset($GLOBALS['PartLocks'][$pbId])) {
      return $GLOBALS['PartLocks'][$pbId];
    } else {
      return false;
    }
  }

}

$GLOBALS['VCSessions'] = array();

/**
 * Global registry easy access to and reuse of VCSessions (and also WorkflowSessions)
 */
class VCSessionRegistry {

  /**
   * Add a VCSession to the global registry
   * @param string $key the key under which it should be registered
   * @param mixed $vcs 
   */
  function addVCSession($key, &$vcs) {
    $GLOBALS['VCSessions'][$key] = &$vcs;
  }

  /**
   * Add the VCSession that should be used as a default to the global registry
   * @param mixed $vcs 
   */
  function addDefaultVCSession(&$vcs) {
    $GLOBALS['VCSessions']['default'] = &$vcs;
  }

  /**
   * Get VCSession by key
   * @param string $key
   * @return mixed $vcs the VCSession or false if not present
   */
  function &getVCSession($key) {
    if (isset($GLOBALS['VCSessions'][$key])) {
      return $GLOBALS['VCSessions'][$key];
    } else {
      return false;
    }
  }

  /**
   * Get default VCSession
   * @return mixed $vcs the VCSession or false if not present
   */
  function &getDefaultVCSession() {
    if (isset($GLOBALS['VCSessions']['default'])) {
      return $GLOBALS['VCSessions']['default'];
    } else {
      return false;
    }
  }

}


class DepGraph {
  var $_matrix;
  
  function DepGraph() {
    $this->_matrix = array();
  }
  
  function addEmptyNode($guid, $orig = false) {
    $keys = array_keys($this->_matrix);
    $this->_matrix[$guid] = array();
    foreach($keys as $key) {
      $this->_matrix[$key][$guid] = false;
      $this->_matrix[$guid][$key] = false;
    }
    $this->_matrix[$guid]['orig'] = $orig;
  }

  /** 
   * $guidsdeps : string $guid => 'deps' => array $deps, 'orig' => bool $orig (if $guid is scheduled for publication)
   */
  function addNodes(&$guidsdeps) {
    $fakePath = '';
    if (is_array($guidsdeps)) { 
      foreach ($guidsdeps as $guid => $info) {
    if (!in_array($guid, array_keys($this->_matrix))) { 
      $this->addEmptyNode($guid, $info['orig']);
    } else {
      $this->_matrix[$guid]['orig'] = $info['orig'];
    }
    foreach ($info['deps'] as $dep) {
      echo "DEP: $dep<br>";
      if (!in_array($dep, array_keys($this->_matrix))) {      
        echo "DEP_EMPTY: $dep<br>";
        $this->addEmptyNode($dep);
      }
      $this->_matrix[$guid][$dep] = true;
    }
      }
    }
  }
  
  /*   function add() {
    $this->_
  }*/

  function warshallComputePaths() {
    foreach ($this->_matrix as $row) {
      $keys = array_keys($this->_matrix);
      foreach($keys as $k) {
    foreach ($keys as $i) {
      foreach ($keys as $j) {
        $this->_matrix[$i][$j] = ($this->_matrix[$i][$j] or ($this->_matrix[$i][$k] and $this->_matrix[$k][$j]));
      }
    }
      }
    }
  }
    
  /**
   * return array: string $unresolvedGuid => array $deps
   */
  function &getMissingDeps() {
    $deps = array();
    $keys = array_keys($this->_matrix);
    foreach ($keys as $i) {
      if ($this->_matrix[$i]['orig']) {
    $deps[$i] = array();
    foreach ($keys as $j) {
      if ($this->_matrix[$i][$j] and !$this->_matrix[$j]['orig']) {
        $deps[$i][] = $j;
      }
    }
      }
    }
    return $deps;
  }

  function printHTML() {
    echo "<table border='1'>";
    foreach ($this->_matrix as $guid => $stuff) {
      $color = $stuff['orig']?'green':'red';
      echo "<tr><td style='background-color:$color'>$guid</td>"; // style='color:" . $stuff['orig']?'blue':'red' . "'>$guid</td>";
      foreach ($stuff as $key=> $val) {
    if ($key == 'orig') continue;
    echo "<td style='background-color:$color'>$key : $val</td>";
      }
      echo "</tr>";
    }
    echo "</table>";
    /**     foreach (*/
  }
    
}


/**
 * Manages configuration and reuse of db connections, MgdDBs, VersionControl objects.
 */
class VCSession {
  var $_dbh;
  var $_glob_dbh;
  var $_mgddb;
  var $_vc;
  var $_nSpace;
  var $_branch;
  var $_branchid;
  var $_branchlabel;
  var $_user;
  var $_outgoing;
  var $_conf;

  /**
   * Construct a new VCSession.
   * @param mixed $arr optional can be an array or a name of a global array that contains configuration data under the keys dbconf, globdbconf, vcconf, fsconf. (see config script)
   * @return object $vcSession
   */
  function VCSession($conf = 0) {
    if (is_array($conf)) {
      $this->_conf = & $conf;
      extract($conf);
    } else {
      if ($conf == 0) {
    $conf = 'VCSessionConf';
      }
      $this->_conf = & $GLOBALS[$conf];
      extract ($GLOBALS[$conf]);
    }
    if (!isset($dbconf['dbhost'])) $dbconf['dbhost'] = 'localhost';
    if (!isset($dbconf['globdbhost'])) $dbconf['globdbhost'] = 'localhost';
    $this->_dbh = DB::connect("mysql://{$dbconf['dbuser']}:{$dbconf['dbpass']}@{$dbconf['dbhost']}/{$dbconf['dbname']}");
    $this->_dbh->setFetchMode(DB_FETCHMODE_ASSOC);
    $this->_glob_dbh = DB::connect("mysql://{$dbconf['globdbuser']}:{$dbconf['globdbpass']}@{$dbconf['globdbhost']}/{$dbconf['globdbname']}");
    $this->_glob_dbh->setFetchMode(DB_FETCHMODE_ASSOC);
    $this->_mgddb = &new MgdDB($this->_dbh, $dbconf, $fsconf);
    $this->_branchid = &$branchid;
    $this->_branchlabel = $this->_glob_dbh->getOne("SELECT label FROM branch WHERE id = $branchid");
    if (isset($vcconf)) {
      $this->_vc = &new CVSVersionControl($vcconf, $fsconf);
      $this->_nSpace = $this->_vc->getNamespace($vcconf['cvsmodule']);
      $this->_branch = $this->_nSpace->getBranch($vcconf['cvsbranch']);
      $this->_outgoing = &$fsconf['outgoing'];
    }
    global $midgard;
    if (is_object($midgard) and $midgard->user != 0) {
      $person = mgd_get_person($midgard->user);
      $this->_user = $person->guid();
    }    
  }
  
  /**
   * Get the DB handle of the Midgard DB.
   * @return object $dbh the handle
   */
  function &getDbh() {
    return $this->_dbh;
  }
  
  /**
   * Get the DB handle of the global DB (that contains meta-data about objects, collections and workflow data)
   * @return object $dbh the handle
   */   
  function &getGlobDbh() {
    return $this->_glob_dbh;
  }

  /** 
   * Get the Midgard DB as a MgdDB object.
   * @return object $mgddb
   */
  function &getMgdDB() {
    return $this->_mgddb;
  }

  /**
   * Get the VersionControl object.
   * @return object $vc
   */
  function &getVersionControl() {
    return $this->_vc;
  }

  /**
   * Get the Namespace object (in CVS, a module)
   * @return object $nSpace
   */
  function &getNamespace() {
    return $this->_nSpace;
  }

  /**
   * Get the Branch object 
   * @return object $branch
   */
  function &getBranch(){
    return $this->_branch;
  }

  /**
   * Get the id of the current branch.
   * @return int $id
   */
  function &getBranchId() {
    return $this->_branchid;
  }

  /**
   * Get the id of the current branch.
   * @return int $id
   */
  function &getBranchLabel() {
    return $this->_branchlabel;
  }

  /**
   * Get the current user (guid)
   * @return int $id
   */
  function &getUser() {
    return $this->_user;
  }

  /**
   * Get the outgoing directory
   * @return int $id
   */
  function &getOutgoing() {
    return $this->_outgoing;
  }


  /** 
   * Get the URL of the spooler on this branch
   * @return string $url
   */
  function getSpoolerUrl() {
    return $this->_conf['urlconf']['spooler'];
  }

  /** 
   * Get the URL of the global status handler script
   * @return string $path
   */
  function getStatusHandler() {
    return $this->_conf['status_handler'];
  }

  /** 
   * Notify the spooler on this branch
   */
  function notifySpooler() {
    batchStart("curl {$this->_conf['urlconf']['spooler']}");
  }

  /** 
   * Notify the global status handler
   */
  function notifyStatusHandler() {
    //    batchStart($this->_conf['statusHandler'] . " >> /tmp/everymin.log");
  }

}

/**
 * Represents a Midgard DB.
 * Can import and export objects via repligard and check their dependencies (uses a repligard config file for configuration)
 */
class MgdDB {
  var $_dbh;
  var $_dbconf;
  var $_fsconf;
  var $_lup;
  var $_ldown;
  var $_xmlcontext;

  /** 
   * Construct a MgdDB
   *
   * @param mixed $dbh connection to the Midgard DB
   * @param array $dbconf db configuration
   * @param array $dbconf filesystem configuration
   */ 
  function MgdDB(&$dbh, &$dbconf, &$fsconf) {
    $this->_dbh = $dbh;
    $this->_dbconf = $dbconf;
    $this->_fsconf = $fsconf;
    $repliconf_xml = file_get_contents($dbconf['repliconffile']);
    $p = xml_parser_create();
    xml_parser_set_option($p,XML_OPTION_SKIP_WHITE,1);
    xml_set_object($p, $this);
    xml_set_element_handler($p, '_init_xml_handler', false);
    @xml_parse($p, $repliconf_xml, true);
    xml_parser_free($p);
  }

  /**
   * To be called only from the XML parser. Uses the tag and attribute information to fill $_lup and $_ldown with links
   * 
   * @param mixed $parser the xml parser
   * @param string $tag the name of the current tag
   * @param array $attrs[] attribute names => values
   */
  function _init_xml_handler($parser, $tag, $attrs) {
    if ($tag == 'TYPE') {
      $this->_xmlcontext = $attrs['NAME'];
    } else if ($tag == 'LINK') {
      $this->_lup[$this->_xmlcontext][$attrs['NAME']] = $attrs['LINK'];
      if ($attrs['REVERSE'] != 'no') {
    $this->_ldown[$attrs['LINK']][$attrs['NAME']] = $this->_xmlcontext;
      }
    } else if ($tag == 'RLINK') {
      $fields = explode(' ',$attrs['LINK']);
      $this->_lup[$this->_xmlcontext][$attrs['NAME']] = $fields;
      $rlink = array();
      $rlink['tablefrom'] = $fields[0];
      $rlink['fieldfrom'] = $fields[1];
      $rlink['fieldto'] = $attrs['NAME'];
      if ($attrs['REVERSE'] != 'no') {
    $this->_ldown['RLINK'][$this->_xmlcontext] = $rlink;
      }
    }
  }
  
  /**
   * Returns a list of objects that this object depends on but do not belong to it.
   * @param string $guid the guid of the object
   * @return array $guids the guids of its dependencies
   */
  function computeDepsUp($guid) {
    global $i18nTables;
    /* RLINK: the second part of the link (field) is ignored, always id */
    $deps = array();
    @extract($this->_dbh->getRow("SELECT realm,id FROM repligard WHERE guid = '$guid'"));
    if (!@$id) {
      trigger_error("Object does not exist.", E_USER_NOTICE);
      return MGD_ERR_ERROR;
    }
    /** content in lang 0 is a requirement if you want to instantiate the i18nd object **/
    echo "\n";
    var_dump($i18nTables);
    echo "\n";
    var_dump($realm);
    echo "\n";
    if (in_array($realm, $i18nTables)) {
      echo "WINTER.\n";
      echo "SELECT repligard.guid FROM {$realm}_i,repligard WHERE {$realm}_i.sid = $id AND {$realm}_i.lang = 0 AND {$realm}_i.id = repligard.id AND repligard.realm = '{$realm}_i'";
      $newdep = $this->_dbh->getOne("SELECT repligard.guid FROM {$realm}_i,repligard WHERE {$realm}_i.sid = $id AND {$realm}_i.lang = 0 AND {$realm}_i.id = repligard.id AND repligard.realm = '{$realm}_i'");
      echo "NEWDEP: $newdep";
      if (is_string($newdep)) {
    $deps[] = $newdep;
      }
    }
    if (is_array($this->_lup[$realm])) {
      foreach($this->_lup[$realm] as $key => $val) {
    if (is_string($val)) {
      $newdep = $this->_dbh->getOne("SELECT repligard.guid FROM $realm,repligard WHERE $realm.id = $id AND $realm.$key = repligard.id AND repligard.realm = '$val'");
    } elseif (is_array($val)) {
      $newdep = $this->_dbh->getOne("SELECT repligard.guid FROM $realm,repligard WHERE $realm.id = $id AND $realm.$key = repligard.id AND repligard.realm = '$realm.$val[0]'");
    }
    if (is_string($newdep)) {
      $deps[] = $newdep;
    }
      }
    }
    return array_unique($deps);
  }

  
  /**
   * Returns a list of objects that depend on / belong to this object.
   * @param string $guid the guid of the object
   * @return array $guids keys: the guids of the objects that depend on it => values: the language ids of the objects (0 if undefined)
   */
  function computeDepsDown($guid) {
    /* RLINK: the second part of the link (field) is ignored, always id */
    $deps = array();
    $deps_lang = array();
    @extract($this->_dbh->getRow("SELECT realm,id FROM repligard WHERE guid = '$guid'"));
    if (!@$id) {
      trigger_error("Object does not exist.", E_USER_NOTICE);
      return MGD_ERR_ERROR;
    }
    if (is_array(@$this->_ldown[$realm])) {
      foreach($this->_ldown[$realm] as $key => $val) {
    if (substr($val, -2) == '_i') {
      $langfield = ', link.lang';
    } else {
      $langfield = '';
    }
    $newdeps = $this->_dbh->query("SELECT repligard.guid $langfield FROM $val AS link,repligard WHERE link.$key = $id AND repligard.realm = '$val' AND repligard.id = link.id");
    while ($row = $newdeps->fetchRow()) {
      if (!in_array($row['guid'], $deps)) {
        $deps[] = $row['guid'];
        $deps_lang[$row['guid']] = isset($row['lang'])?$row['lang']:0;
      }
    }
      }
    }
    if (is_array(@$this->_ldown['RLINK'])) {
      foreach($this->_ldown['RLINK'] as $key => $val) {
    if (substr($val['tablefrom'], -2) == '_i') {
      $langfield = ', link.lang';
    } else {
      $langfield = '';
    }
    $newdeps = $this->_dbh->query("SELECT repligard.guid $langfield FROM $key AS link,repligard WHERE link.{$val['fieldto']} = $id AND link.{$val['tablefrom']} = '$realm' AND repligard.realm = '$key' AND repligard.id = link.id");
    while (is_object($newdeps) and $row = $newdeps->fetchRow()) {
      if (!in_array($row['guid'], $deps)) {
        $deps[] = $row['guid'];
        $deps_lang[$row['guid']] = isset($row['lang'])?$row['lang']:0;
      }
    }
      }
    }
    return $deps_lang;
  }
  
  /**
   * Returns a list of objects that this object belongs to.
   * (Should improve the naming)
   * @param string $guid
   * @return array $guids 
   */
  function computeDepsDownReverse($guid) {
    $deps = array();
    extract(@$this->_dbh->getRow("SELECT realm,id FROM repligard WHERE guid = '$guid'"));
    foreach(