do_actions.php File Reference

Go to the source code of this file.

Functions
	d ($mess)
	Debug function that print infos. More...
	mail_it ()
	Function to mail the panel's administrator if something failed. More...
	execute_cmd ($command, $parameters=array())
	Common routine for system calls. More...
	my_realpath ($path)
	Check if a file or folder is in the list of allowed path (after dereferencing all ../ and symlinks. More...

Variables
	$debug =0
	This script check the MySQL DB for actions to do, and do them one by one. More...
	$errorsList =array()
if(!defined("ALTERNC_DO_ACTION_LOCK"))	$SCRIPT ='/usr/bin/php do_actions.php'
	$MY_PID =getmypid()
	$FIXPERM ='/usr/lib/alternc/fixperms.sh'
if(file_exists(ALTERNC_DO_ACTION_LOCK) !==false)	else

Function Documentation

d()

d

(

$mess

)

Debug function that print infos.

Parameters

	global	int $debug
type	$mess

Definition at line 75 of file do_actions.php.

                 {
  global $debug;
  if ($debug == 1)
    echo "$mess\n";
}

References $debug.

execute_cmd()

execute_cmd	(		$command,
			$parameters = array()
	)

Common routine for system calls.

Parameters

type	$command	the command
type	$parameters	of the command (they are going to be protected)

Returns

array('output'=>'output of exec', 'return_val'=>'returned integer of exec')

Definition at line 106 of file do_actions.php.

                                                    {
  $cmd_line = "$command ";
  if (!empty($parameters)) {
    if (is_array($parameters)) {
      foreach($parameters as $pp) {
        $cmd_line.= " ".escapeshellarg($pp)." ";
      }
    } else {
      $cmd_line.= " ".escapeshellarg($parameters)." " ;
    }
  }
  $cmd_line.= " 2>&1";
  exec($cmd_line, $output, $code);
  return array('executed' => $cmd_line, 'output'=>$output, 'return_val'=>$code);
}

mail_it()

mail_it

(

)

Function to mail the panel's administrator if something failed.

Parameters

global	array $errorsList
global	type $L_FQDN

Definition at line 86 of file do_actions.php.

                  {
  global $errorsList,$L_FQDN;
  // Forces array
  if( !is_array($errorsList)){
      $errorsList = array($errorsList);
  }
  // Builds message from array
  $msg = implode("\n", $errorsList);
  // Attempts to send email
  // @todo log if fails 
  mail("alterncpanel@$L_FQDN",'Script do_actions.php issues',"\n Errors reporting mail:\n\n$msg");
}

References $errorsList, and $msg.

my_realpath()

my_realpath

(

$path

)

Check if a file or folder is in the list of allowed path (after dereferencing all ../ and symlinks.

Parameters

$path

string the path to check against

Returns

string the dereferenced path, or FALSE if the path is NOT allowed (/var/www/alternc /var/mail/alternc)

Definition at line 127 of file do_actions.php.

                            {
    global $L_ALTERNC_HTML, $L_ALTERNC_MAIL;
    // add here any allowed path: 
    $allowed=array(realpath($L_ALTERNC_HTML)."/", realpath($L_ALTERNC_MAIL)."/");
    $path=realpath($path);
    foreach($allowed as $one) {
        // the path must be BELOW each allowed folder. forbid anything 
        if (strlen($path)>strlen($one) && substr($path,0,strlen($one))==$one) {
            return $path;
        }
    }
    return false;
}
 
// Check if script isn't already running
if (file_exists(ALTERNC_DO_ACTION_LOCK) !== false){
    d("Lock file already exists. ");
    // Check if file is in process list
    $PID=file_get_contents(ALTERNC_DO_ACTION_LOCK);
    d("My PID is $MY_PID, PID in the lock file is $PID");
    if ($PID == exec("pidof $SCRIPT | tr ' ' '\n' | grep -v $MY_PID")){
      // Previous cron is not finished yet, just exit
      d("Previous cron is already running, we just exit and let it finish :-)");
      exit(0);
    }else{
      // Previous cron failed!
      $errorsList[]="Lock file already exists. No process with PID $PID found! Previous cron failed...\n";
 
      // No need to remove anything, we're going to recreate it
      //d("Removing lock file and trying to process the failed action...");
      // Delete the lock and continue to the next action
      //unlink(ALTERNC_DO_ACTION_LOCK);
 
      // Lock with the current script's PID
      if (file_put_contents(ALTERNC_DO_ACTION_LOCK,$MY_PID) === false){
        $errorsList[]="Cannot open/write ALTERNC_DO_ACTION_LOCK\n";
        mail_it();
        exit(1);
      }
 
      // Get the action(s) that was processing when previous script failed
      // (Normally, there will be at most 1 job pending... but who know?)
      while($cc=$action->get_job()){
        $c=$cc[0];
        $params=unserialize($c["parameters"]);
        // We can resume these types of action, so we reset the job to process it later
        d("Previous job was the n°".$c["id"]." : '".$c["type"]."'");
        if($c["type"] == "CREATE_FILE" && is_dir(dirname($params["file"])) || $c["type"] == "CREATE_DIR" || $c["type"] == "DELETE" || $c["type"] == "FIX_DIR" || $c["type"] == "FIX_FILE"){
          d("Reset of the job! So it will be resumed...");
          $action->reset_job($c["id"]);
        }else{
          // We can't resume the others types, notify the fail and finish this action
          $errorsList[]="Can't resume the job n°".$c["id"]." action '".$c["type"]."', finishing it with a fail status.\n";
          if(!$action->finish($c["id"],"Fail: Previous script crashed while processing this action, cannot resume it.")){
            $errorsList[]="Cannot finish the action! Error while inserting the error value in the DB for action n°".$c["id"]." : action '".$c["type"]."'\n";
            break; // Else we go into an infinite loop... AAAAHHHHHH
          }
        }
      }
    }
}else{

Variable Documentation

$debug

$debug =0

This script check the MySQL DB for actions to do, and do them one by one.

Copyright

AlternC-Team 2002-2013 http://alternc.org/

Definition at line 48 of file do_actions.php.

Referenced by d().

$errorsList

$errorsList =array()

Definition at line 51 of file do_actions.php.

Referenced by mail_it().

$FIXPERM

$FIXPERM ='/usr/lib/alternc/fixperms.sh'

Definition at line 65 of file do_actions.php.

$MY_PID

$MY_PID =getmypid()

Definition at line 64 of file do_actions.php.

$SCRIPT

if (!defined("ALTERNC_DO_ACTION_LOCK")) $SCRIPT ='/usr/bin/php do_actions.php'

Definition at line 63 of file do_actions.php.

else

if (file_exists(ALTERNC_DO_ACTION_LOCK) !==false) else

Definition at line 187 of file do_actions.php.