processmaker-files/workflow/engine/bin/verify_solr.php

<?php
/**
 *
 * ProcessMaker Open Source Edition
 * Copyright (C) 2004 - 2012 Colosa Inc.23
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * For more information, contact Colosa Inc, 5304 Ventura Drive,
 * Delray Beach, FL, 33484, USA, or email info@colosa.com.
 *
 */

// check script parameters
// php reindex_solr.php workspacename [reindexall|reindexmissing|optimizeindex] [-skip 1005] [-reindextrunksize 1000]
// var_dump($argv);
//(count ($argv) == 4) || ((count ($argv) == 5) && ($argv [3] != '-skip'))
use ProcessMaker\Core\System;

$commandLineSyntaxMsg = "Invalid command line arguments: \n " .
  "Verify the list of cases comparing db vs solr lists by user if usr_uid is specify only verify one user otherwhise all users ".
  "syntax: ".
  "php verify_solr.php [workspace_name] [-usruid {USR_UID}]\n" .
  " Where \n".
  "       workspace_name : is the workspace that is being verified. \n" .
  " Optional Options: \n" .
  " -usruid {USR_UID}: verify only one user with the specified user uid. \n ";

if ( (count ($argv) < 2) || ((count ($argv) > 2) && ((count ($argv) % 2) != 0))) {
  print $commandLineSyntaxMsg;
  die ();
}
$workspaceName = $argv [1];
$usrUid = "";

if((count ($argv) > 2)){
  $usrUid = $argv [3];
}

$debug = 1;//enable o disable notice, this mechanism is inherited from '/processmaker/workflow/engine/bin/reindex_solr.php'

ini_set ('display_errors', 1);

ini_set ('memory_limit', '256M'); // set enough memory for the script

$e_all = defined( 'E_DEPRECATED' ) ? E_ALL & ~ E_DEPRECATED : E_ALL;
$e_all = defined( 'E_STRICT' ) ? $e_all & ~ E_STRICT : $e_all;
$e_all = $debug ? $e_all : $e_all & ~ E_NOTICE;

ini_set( 'error_reporting', $e_all );

if (! defined ('SYS_LANG')) {
  define ('SYS_LANG', 'en');
}

if (! defined ('PATH_HOME')) {
  if (! defined ('PATH_SEP')) {
    define ('PATH_SEP', (substr (PHP_OS, 0, 3) == 'WIN') ? '\\' : '/');
  }
  $docuroot = explode (PATH_SEP, str_replace ('engine' . PATH_SEP . 'methods' . PATH_SEP . 'services', '', dirname (__FILE__)));
  array_pop ($docuroot);
  array_pop ($docuroot);
  $pathhome = implode (PATH_SEP, $docuroot) . PATH_SEP;
  // try to find automatically the trunk directory where are placed the RBAC and
  // Gulliver directories
  // in a normal installation you don't need to change it.
  array_pop ($docuroot);
  $pathTrunk = implode (PATH_SEP, $docuroot) . PATH_SEP;
  array_pop ($docuroot);
  $pathOutTrunk = implode (PATH_SEP, $docuroot) . PATH_SEP;
  // to do: check previous algorith for Windows $pathTrunk = "c:/home/";

  define ('PATH_HOME', $pathhome);
  define ('PATH_TRUNK', $pathTrunk);
  define ('PATH_OUTTRUNK', $pathOutTrunk);
  define( 'PATH_CLASSES', PATH_HOME . "engine" . PATH_SEP . "classes" . PATH_SEP );

  require_once PATH_TRUNK . "framework/src/Maveriks/Util/ClassLoader.php";
  require_once (PATH_HOME . 'engine' . PATH_SEP . 'config' . PATH_SEP . 'paths.php');
  spl_autoload_register(array('Bootstrap', 'autoloadClass'));


}

print "PATH_HOME: " . PATH_HOME . "\n";
print "PATH_DB: " . PATH_DB . "\n";
print "PATH_CORE: " . PATH_CORE . "\n";

// define the site name (instance name)
if (empty(config("system.workspace"))) {
  $sObject = $workspaceName;
  $sNow = ''; // $argv[2];
  /*
  $sFilter = '';

  for ($i = 3; $i < count ($argv); $i++) {
    $sFilter .= ' ' . $argv [$i];
  }*/

  $oDirectory = dir (PATH_DB);

  if (is_dir (PATH_DB . $sObject)) {
    saveLog ('main', 'action', "checking folder " . PATH_DB . $sObject);
    if (file_exists (PATH_DB . $sObject . PATH_SEP . 'db.php')) {

      define ('SYS_SYS', $sObject);
      config(["system.workspace" => $sObject]);

      // ****************************************
      // read initialize file
      require_once PATH_HOME . 'engine' . PATH_SEP . 'classes' . PATH_SEP . 'class.system.php';
      $config = System::getSystemConfiguration ('', '', config("system.workspace"));
      define ('MEMCACHED_ENABLED', $config ['memcached']);
      define ('MEMCACHED_SERVER', $config ['memcached_server']);
      define ('TIME_ZONE', $config ['time_zone']);

      date_default_timezone_set (TIME_ZONE);
      
      // ****************************************

      include_once (PATH_HOME . 'engine' . PATH_SEP . 'config' . PATH_SEP . 'paths_installed.php');
      include_once (PATH_HOME . 'engine' . PATH_SEP . 'config' . PATH_SEP . 'paths.php');


      $filter = new InputFilter();
      $TIME_ZONE = $filter->xssFilterHard(TIME_ZONE);
      $MEMCACHED_ENABLED = $filter->xssFilterHard(MEMCACHED_ENABLED);
      $MEMCACHED_SERVER = $filter->xssFilterHard(MEMCACHED_SERVER);
      
      print "TIME_ZONE: " . $TIME_ZONE . "\n";
      print "MEMCACHED_ENABLED: " . $MEMCACHED_ENABLED . "\n";
      print "MEMCACHED_SERVER: " . $MEMCACHED_SERVER . "\n";

      // ***************** PM Paths DATA **************************
      define ('PATH_DATA_SITE', PATH_DATA . 'sites/' . config("system.workspace") . '/');
      define ('PATH_DOCUMENT', PATH_DATA_SITE . 'files/');
      define ('PATH_DATA_MAILTEMPLATES', PATH_DATA_SITE . 'mailTemplates/');
      define ('PATH_DATA_PUBLIC', PATH_DATA_SITE . 'public/');
      define ('PATH_DATA_REPORTS', PATH_DATA_SITE . 'reports/');
      define ('PATH_DYNAFORM', PATH_DATA_SITE . 'xmlForms/');
      define ('PATH_IMAGES_ENVIRONMENT_FILES', PATH_DATA_SITE . 'usersFiles' . PATH_SEP);
      define ('PATH_IMAGES_ENVIRONMENT_USERS', PATH_DATA_SITE . 'usersPhotographies' . PATH_SEP);

      // server info file
      if (is_file (PATH_DATA_SITE . PATH_SEP . '.server_info')) {
        $SERVER_INFO = file_get_contents (PATH_DATA_SITE . PATH_SEP . '.server_info');
        $SERVER_INFO = unserialize ($SERVER_INFO);
        // print_r($SERVER_INFO);
        define ('SERVER_NAME', $SERVER_INFO ['SERVER_NAME']);
        define ('SERVER_PORT', $SERVER_INFO ['SERVER_PORT']);
      }
      else {
        eprintln ("WARNING! No server info found!", 'red');
      }

      // read db configuration
      $sContent = file_get_contents (PATH_DB . $sObject . PATH_SEP . 'db.php');

      $sContent = str_replace ('<?php', '', $sContent);
      $sContent = str_replace ('<?', '', $sContent);
      $sContent = str_replace ('?>', '', $sContent);
      $sContent = str_replace ('define', '', $sContent);
      $sContent = str_replace ("('", "$", $sContent);
      $sContent = str_replace ("',", '=', $sContent);
      $sContent = str_replace (");", ';', $sContent);

      eval ($sContent);
      $dsn = $DB_ADAPTER . '://' . $DB_USER . ':' . $DB_PASS . '@' . $DB_HOST . '/' . $DB_NAME;
      $dsnRbac = $DB_ADAPTER . '://' . $DB_RBAC_USER . ':' . $DB_RBAC_PASS . '@' . $DB_RBAC_HOST . '/' . $DB_RBAC_NAME;
      $dsnRp = $DB_ADAPTER . '://' . $DB_REPORT_USER . ':' . $DB_REPORT_PASS . '@' . $DB_REPORT_HOST . '/' . $DB_REPORT_NAME;
      switch ($DB_ADAPTER) {
        case 'mysql' :
          $dsn .= '?encoding=utf8';
          $dsnRbac .= '?encoding=utf8';
          break;
        case 'mssql' :
          // $dsn .= '?sendStringAsUnicode=false';
          // $dsnRbac .= '?sendStringAsUnicode=false';
          break;
        default :
          break;
      }
      // initialize db
      $pro ['datasources'] ['workflow'] ['connection'] = $dsn;
      $pro ['datasources'] ['workflow'] ['adapter'] = $DB_ADAPTER;
      $pro ['datasources'] ['rbac'] ['connection'] = $dsnRbac;
      $pro ['datasources'] ['rbac'] ['adapter'] = $DB_ADAPTER;
      $pro ['datasources'] ['rp'] ['connection'] = $dsnRp;
      $pro ['datasources'] ['rp'] ['adapter'] = $DB_ADAPTER;
      // $pro['datasources']['dbarray']['connection'] =
      // 'dbarray://user:pass@localhost/pm_os';
      // $pro['datasources']['dbarray']['adapter'] = 'dbarray';
      $oFile = fopen (PATH_CORE . 'config/_databases_.php', 'w');
      fwrite ($oFile, '<?php global $pro;return $pro; ?>');
      fclose ($oFile);
      Propel::init (PATH_CORE . 'config/_databases_.php');
      // Creole::registerDriver('dbarray', 'creole.contrib.DBArrayConnection');

      eprintln ("Processing workspace: " . $sObject, 'green');
      try {
        processWorkspace ();
      }
      catch (Exception $e) {
        $token = strtotime("now");
        PMException::registerErrorLog($e, $token);
        G::outRes( G::LoadTranslation("ID_EXCEPTION_LOG_INTERFAZ", array($token)) );
        eprintln ("Problem in workspace: " . $sObject . ' it was omitted.', 'red');
      }
      eprintln ();
      unlink (PATH_CORE . 'config/_databases_.php');
    }
  }

}
else {
  processWorkspace ();
}

function processWorkspace()
{
  global $sLastExecution;
  global $ScriptAction;
  //global $SkipRecords;
  //global $TrunkSize;
  global $usrUid;

  try {

    //if $usrUid is not set get all the users

    //verify inbox
    verifyInboxList($usrUid);

    //verify draft
    verifyDraftList($usrUid);

    //verify participated list
    verifyParticipatedList($usrUid);

    //verify unassigned list
    verifyUnassignedList($usrUid);

  }
  catch (Exception $oError) {
    saveLog ("main", "error", "Error processing workspace : " . $oError->getMessage () . "\n");
  }
}

function verifyInboxList($usrUid)
{
  print "***********************\n";
  print "Verify Inbox list:  \n";
  print "***********************\n";

  $result = getListUids($usrUid, 'todo');

  $aAppUidsDB = $result['aDBAppUids'];
  $aAppUidsSolr = $result['aSolrAppUids'];

  displayMissingCases($aAppUidsDB, $aAppUidsSolr);
}

function verifyDraftList($usrUid)
{
  print "***********************\n";
  print "Verify Draft list: \n";
  print "***********************\n";

  $result = getListUids($usrUid, 'draft');

  $aAppUidsDB = $result['aDBAppUids'];
  $aAppUidsSolr = $result['aSolrAppUids'];

  displayMissingCases($aAppUidsDB, $aAppUidsSolr);
}

function verifyParticipatedList($usrUid)
{
  print "******************************\n";
  print "Verify Participated list: \n";
  print "******************************\n";

  $result = getListUids($usrUid, 'sent');

  $aAppUidsDB = $result['aDBAppUids'];
  $aAppUidsSolr = $result['aSolrAppUids'];

  displayMissingCases($aAppUidsDB, $aAppUidsSolr);
}

function verifyUnassignedList($usrUid)
{
  print "******************************\n";
  print "Verify Unassigned list: \n";
  print "******************************\n";

  $result = getListUids($usrUid, 'unassigned');

  $aAppUidsDB = $result['aDBAppUids'];
  $aAppUidsSolr = $result['aSolrAppUids'];

  displayMissingCases($aAppUidsDB, $aAppUidsSolr);
}

function displayMissingCases($aAppUidsDB, $aAppUidsSolr)
{
  //verify missing records
  //verify size
  print "  Number of cases: DB:" . count($aAppUidsDB) . " Solr:" . count($aAppUidsSolr) . "\n";
  //
  if( count($aAppUidsDB) != count($aAppUidsSolr) ){
    print "  Different number of cases !!! \n";
  }

  $casesInDBNotSolr = array_diff($aAppUidsDB, $aAppUidsSolr);
  $casesInSolrNotDB = array_diff($aAppUidsSolr, $aAppUidsDB);

  print "  Cases in DB but not in Solr: \n";
  foreach($casesInDBNotSolr as $caseDB){
    print "  ". $caseDB . " \n";
  }
  print "  Cases in Solr but not in DB: \n";
  foreach($casesInSolrNotDB as $caseSolr){
    print "  ". $caseSolr . " \n";
  }
}

function getListUids($usrUid, $action)
{
  if (($solrConf = System::solrEnv (config("system.workspace"))) !== false) {

    print "Solr Configuration file: " . PATH_DATA_SITE . "env.ini\n";
    print "solr_enabled: " . $solrConf ['solr_enabled'] . "\n";
    print "solr_host: " . $solrConf ['solr_host'] . "\n";
    print "solr_instance: " . $solrConf ['solr_instance'] . "\n";

    $oAppSolr = new AppSolr ($solrConf ['solr_enabled'], $solrConf ['solr_host'], $solrConf ['solr_instance']);

    $apps = new Applications();
  }
  else {
    print "Incomplete Solr configuration. See configuration file: " . PATH_DATA_SITE . "env.ini";
    return;
  }
  //get the list of id's
  $userUid = $usrUid;
  $start = 0;
  $limit = 1;
  $action = $action; //todo,
  $filter = '';
  $search = '';
  $process = '';
  $user = '';
  $status = '';
  $type = 'extjs';
  $dateFrom = '';
  $dateTo = '';
  $callback = 'stcCallback1001';
  $dir = 'DESC';
  $sort = 'APP_NUMBER';
  $category = '';

  $dataSolr = $oAppSolr->getAppGridData(
      $userUid,
      $start,
      $limit,
      $action,
      $filter,
      $search,
      $process,
      $user,
      $status,
      $type,
      $dateFrom,
      $dateTo,
      $callback,
      $dir,
      $sort
  );


  $dataDB = $apps->getAll(
      $userUid,
      $start,
      $limit,
      $action,
      $filter,
      $search,
      $process,
      $user,
      $status,
      $type,
      $dateFrom,
      $dateTo,
      $callback,
      $dir,
      $sort,
      $category
  );

  $aAppUidsSolr = array();
  $aAppUidsDB = array();
  $trunkSize = 1000;

  //get DB uids
  print "Get DB Uids \n";
  $totalCasesDB = $dataDB["totalCount"];
  $loops = ((($totalCasesDB % $trunkSize) > 0 )? ($totalCasesDB / $trunkSize)+1: ($totalCasesDB / $trunkSize));
  for ($i = 0; $i < $loops; $i++) {
    $start = $i * $trunkSize;
    $limit = $trunkSize;
    //print "  Loop $start to " . (String)($start + $trunkSize) . " \n";

    $dataDB = $apps->getAll(
        $userUid,
        $start,
        $limit,
        $action,
        $filter,
        $search,
        $process,
        $user,
        $status,
        $type,
        $dateFrom,
        $dateTo,
        $callback,
        $dir,
        $sort,
        $category
    );
    foreach($dataDB["data"] as $caseDB){
      $aAppUidsDB[] = $caseDB["APP_UID"];
    }
  }

  //get Solr uids
  print "Get Solr Uids \n";
  $totalCasesSolr = $dataSolr["totalCount"];
  $loops = ((($totalCasesSolr % $trunkSize) > 0 )? ($totalCasesSolr / $trunkSize)+1: ($totalCasesSolr / $trunkSize));
  for ($i = 0; $i < $loops; $i++) {
    $start = $i * $trunkSize;
    $limit = $trunkSize;
    //print "  Loop $start to " . (String)($start + $trunkSize) . " \n";

    $dataSolr = $oAppSolr->getAppGridData(
      $userUid,
      $start,
      $limit,
      $action,
      $filter,
      $search,
      $process,
      $user,
      $status,
      $type,
      $dateFrom,
      $dateTo,
      $callback,
      $dir,
      $sort
    );

    foreach($dataSolr["data"] as $caseSolr){
      $aAppUidsSolr[] = $caseSolr["APP_UID"];
    }
  }

  $result = array();
  $result['total_cases_db'] = $totalCasesDB;
  $result['aDBAppUids'] = $aAppUidsDB;
  $result['total_cases_solr'] = $totalCasesSolr;
  $result['aSolrAppUids'] = $aAppUidsSolr;


  return $result;
}

function saveLog($sSource, $sType, $sDescription)
{
  try {
    global $isDebug;
    if ($isDebug)
      print date ('H:i:s') . " ($sSource) $sType $sDescription <br>\n";

    G::verifyPath (PATH_DATA . 'log' . PATH_SEP, true);
    $message = '(' . $sSource . ') ' . $sDescription;
    if ($sType == 'action') {
      G::log($message, PATH_DATA);
    }
    else {
      G::log($message, PATH_DATA, 'cronError.log');
    }
  }
  catch (Exception $oError) {
    // CONTINUE
  }
}

function setExecutionMessage($m)
{
  $len = strlen ($m);
  $linesize = 60;
  $rOffset = $linesize - $len;

  eprint ("* $m");
  for ($i = 0; $i < $rOffset; $i++)
    eprint ('.');
}

function setExecutionResultMessage($m, $t = '')
{
  $c = 'green';
  if ($t == 'error')
    $c = 'red';
  if ($t == 'info')
    $c = 'yellow';
  eprintln ("[$m]", $c);
}