TorrentFlux-b4rt-PHP7/html/inc/classes/FluAzu.php

<?php

/* $Id: FluAzu.php 3057 2007-05-27 13:06:39Z b4rt $ */

/*******************************************************************************

 LICENSE

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License (GPL)
 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.

 To read the license please visit http://www.gnu.org/copyleft/gpl.html

*******************************************************************************/

// states
define('FLUAZU_STATE_NULL', 0);                                          // null
define('FLUAZU_STATE_RUNNING', 1);                                   //  running
define('FLUAZU_STATE_ERROR', -1);                                       // error

/**
 * class FluAzu for integration of fluazu
 */
class FluAzu
{
	// public fields

    // state
    var $state = FLUAZU_STATE_NULL;

    // messages-array
    var $messages = array();

    // private fields

    // pid
    var $_pid = "";

    // some path-vars for FluAzu
    var $_pathDataDir = "";
	var $_pathCommandFile = "";
    var $_pathPidFile = "";
    var $_pathLogFile = "";
    var $_pathStatFile = "";
    var $_pathTransfers = "";
    var $_pathTransfersRun = "";
    var $_pathTransfersDel = "";

	// commands-array
    var $_commands = array();

	// =========================================================================
	// public static methods
	// =========================================================================

    /**
     * accessor for singleton
     *
     * @return FluAzu
     */
    function getInstance() {
		global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu;
    }

    /**
     * initialize FluAzu.
     */
    function initialize() {
    	global $instanceFluAzu;
    	// create instance
    	if (!isset($instanceFluAzu))
    		$instanceFluAzu = new FluAzu();
    }

    /**
     * accessor for state
     *
     * @return int
     */
    function getState() {
		global $instanceFluAzu;
		return (isset($instanceFluAzu))
			? $instanceFluAzu->state
			: FLUAZU_STATE_NULL;
    }

    /**
     * getMessages
     *
     * @return array
     */
    function getMessages() {
    	global $instanceFluAzu;
		return (isset($instanceFluAzu))
			? $instanceFluAzu->messages
			: array();
    }

    /**
     * isRunning
     *
     * @return boolean
     */
    function isRunning() {
    	global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_isRunning();
    }

	/**
     * start
     *
     * @return boolean
     */
    function start() {
		global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_start();
    }

    /**
     * stop
     */
    function stop() {
		global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_stop();
    }

    /**
     * getPid
     *
     * @return int with pid
     */
    function getPid() {
    	global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_getPid();
    }

    /**
     * writes a message to the log
     *
     * @param $message
     * @param $withTS
     * @return boolean
     */
    function logMessage($message, $withTS = true) {
    	global $instanceFluAzu;
 		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_logMessage($message, $withTS);
    }

    /**
     * send command
     *
     * @param $command
     * @param $autosend
     * @return boolean
     */
    function addCommand($command, $autosend = false) {
    	global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_addCommand($command, $autosend);
    }

    /**
     * send commands
     *
     * @return boolean
     */
    function sendCommands() {
    	global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_sendCommands();
    }

    /**
     * del transfer
     *
     * @param $transfer
     * @return boolean
     */
    function delTransfer($transfer) {
    	global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_delTransfer($transfer);
    }

    /**
     * transfer exists
     *
     * @param $transfer
     * @return boolean
     */
    function transferExists($transfer) {
    	global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_transferExists($transfer);
    }

    /**
     * get status
     *
     * @return array
     */
    function getStatus() {
    	global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_getStatus();
    }

    /**
     * get status-keys
     *
     * @return array
     */
    function getStatusKeys() {
    	global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_getStatusKeys();
    }

    /**
     * set global upload rate
     *
     * @param $uprate
     * @param $autosend
     */
    function setRateUpload($uprate, $autosend = false) {
    	global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_setRateUpload($uprate, $autosend);
    }

    /**
     * set global download rate
     *
     * @param $downrate
     * @param $autosend
     */
    function setRateDownload($downrate, $autosend = false) {
    	global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_setRateDownload($downrate, $autosend);
    }

    /**
     * set a azu-setting
     *
     * @param $key
     * @param $val
     * @param $autosend
     */
    function setAzu($key, $val, $autosend = false) {
    	global $instanceFluAzu;
		// initialize if needed
		if (!isset($instanceFluAzu))
			FluAzu::initialize();
		return $instanceFluAzu->instance_setAzu($key, $val, $autosend);
    }

	// =========================================================================
	// ctor
	// =========================================================================

    /**
     * ctor
     */
    function FluAzu() {
    	global $cfg;
    	// paths
        $this->_pathDataDir = $cfg["path"] . '.fluazu/';
        $this->_pathPidFile = $this->_pathDataDir . 'fluazu.pid';
        $this->_pathCommandFile = $this->_pathDataDir . 'fluazu.cmd';
        $this->_pathLogFile = $this->_pathDataDir . 'fluazu.log';
        $this->_pathStatFile = $this->_pathDataDir . 'fluazu.stat';
        $this->_pathTransfers = $this->_pathDataDir . 'cur/';
        $this->_pathTransfersRun = $this->_pathDataDir . 'run/';
        $this->_pathTransfersDel = $this->_pathDataDir . 'del/';
        // check path
		if (!checkDirectory($this->_pathDataDir)) {
			@error("fluazu-Main-Path does not exist and cannot be created or is not writable",
				"admin.php?op=serverSettings", "Server-Settings",
				array("path : ".$this->_pathDataDir)
			);
		}
        // check if fluazu running
        if ($this->instance_isRunning())
        	$this->state = FLUAZU_STATE_RUNNING;
    }

	// =========================================================================
	// public methods
	// =========================================================================

    /**
     * instance_start
     *
     * @return boolean
     */
    function instance_start() {
    	global $cfg;
        if ($this->state == FLUAZU_STATE_RUNNING) {
            AuditAction($cfg["constants"]["error"], "fluazu already started");
            return false;
        } else {
			// check the needed bins
			// python
			if (@file_exists($cfg['pythonCmd']) !== true) {
				$msg = "cannot start fluazu, specified python-binary does not exist: ".$cfg['pythonCmd'];
            	AuditAction($cfg["constants"]["error"], $msg);
            	array_push($this->messages , $msg);
            	// Set the state
            	$this->state = FLUAZU_STATE_ERROR;
            	// return
            	return false;
			}
			// start it
            $startCommand = "cd ".tfb_shellencode($cfg["docroot"]."bin/clients/fluazu/")."; HOME=".tfb_shellencode($cfg["path"]).";";
            $startCommand .= " export HOME;";
            $startCommand .= " nohup";
            $startCommand .= " ".$cfg["pythonCmd"]." -OO";
            $startCommand .= " fluazu.py";
            $startCommand .= " ".tfb_shellencode($cfg["path"]);
            $startCommand .= " ".tfb_shellencode($cfg["fluazu_host"]);
            $startCommand .= " ".tfb_shellencode($cfg["fluazu_port"]);
            $startCommand .= " ".tfb_shellencode($cfg["fluazu_secure"]);
            $startCommand .= ($cfg["fluazu_user"] == "")
            	? ' ""'
            	: " ".tfb_shellencode($cfg["fluazu_user"]);
            $startCommand .= ($cfg["fluazu_pw"] == "")
            	? ' ""'
            	: " ".tfb_shellencode($cfg["fluazu_pw"]);
	        $startCommand .= " 1>> ".tfb_shellencode($this->_pathLogFile);
	        $startCommand .= " 2>> ".tfb_shellencode($this->_pathLogFile);
	        $startCommand .= " &";
			// log the command
        	$this->instance_logMessage("executing command : \n".$startCommand."\n", true);
        	// exec
            $result = exec($startCommand);
            // check if fluazu could be started
            $loop = true;
            $maxLoops = 125;
            $loopCtr = 0;
            $started = false;
            while ($loop) {
            	@clearstatcache();
            	if (file_exists($this->_pathStatFile)) {
            		$started = true;
            		$loop = false;
            	} else {
	            	$loopCtr++;
	            	if ($loopCtr > $maxLoops)
	            		$loop = false;
	            	else
	            		usleep(200000); // wait for 0.2 seconds
            	}
            }
            // check if started
            if ($started) {
            	AuditAction($cfg["constants"]["admin"], "fluazu started");
            	// Set the state
            	$this->state = FLUAZU_STATE_RUNNING;
            	// return
            	return true;
            } else {
            	AuditAction($cfg["constants"]["error"], "errors starting fluazu");
            	// Set the state
            	$this->state = FLUAZU_STATE_ERROR;
            	// return
            	return false;
            }
        }
    }

    /**
     * instance_stop
     */
    function instance_stop() {
    	global $cfg;
        if ($this->state == FLUAZU_STATE_RUNNING) {
        	AuditAction($cfg["constants"]["admin"], "Stopping fluazu");
            $this->instance_addCommand('q', true);
            // check if fluazu still running
            $maxLoops = 125;
            $loopCtr = 0;
            for (;;) {
            	@clearstatcache();
            	if ($this->instance_isRunning()) {
	            	$loopCtr++;
	            	if ($loopCtr > $maxLoops)
	            		return 0;
	            	else
	            		usleep(200000); // wait for 0.2 seconds
            	} else {
            		// Set the state
            		$this->state = FLUAZU_STATE_NULL;
            		// return
            		return 1;
            	}
            }
            return 0;
        } else {
        	$msg = "errors stopping fluazu as was not running.";
        	AuditAction($cfg["constants"]["error"], $msg);
        	array_push($this->messages , $msg);
            // Set the state
            $this->state = FLUAZU_STATE_ERROR;
			return 0;
        }
    }

    /**
     * isRunning
     *
     * @return boolean
     */
    function instance_isRunning() {
    	return file_exists($this->_pathPidFile);
    }

    /**
     * instance_getPid
     *
     * @return string with pid
     */
    function instance_getPid() {
    	if ($this->_pid != "") {
    		return $this->_pid;
    	} else {
    		$this->_pid = @rtrim(file_get_contents($this->_pathPidFile));
    		return $this->_pid;
    	}
    }

    /**
     * writes a message to the log
     *
     * @param $message
     * @param $withTS
     * @return boolean
     */
    function instance_logMessage($message, $withTS = true) {
		return $this->_log($this->_pathLogFile, $message, $withTS);
    }

    /**
     * send command
     *
     * @param $command
     * @param $autosend
     * @return boolean
     */
    function instance_addCommand($command, $autosend = false) {
    	if (!isset($this->_commands))
    		$this->_commands = array();
    	if ((!in_array($command, $this->_commands)) && (strlen($command) > 0)) {
    		array_push($this->_commands, $command);
    		return ($autosend)
    			? $this->sendCommands()
    			: true;
    	} else {
			return false;
    	}
    }

    /**
     * send commands
     *
     * @return boolean
     */
    function instance_sendCommands() {
    	if (($this->state == FLUAZU_STATE_RUNNING) && (!empty($this->_commands))) {
    		$content = implode("\n", $this->_commands)."\n";
    		$this->_commands = array();
    		return $this->_writeCommandFile($content);
    	} else {
    		return false;
    	}
    }

    /**
     * del transfer
     *
     * @param $transfer
     * @return boolean
     */
    function instance_delTransfer($transfer) {
    	global $cfg;
        if ($this->state == FLUAZU_STATE_RUNNING) {
        	// debug-log
			if ($cfg['debuglevel'] > 0)
        		AuditAction($cfg["constants"]["debug"], "fluazu deleting transfer ".$transfer);
        	// write file
        	$file = $this->_pathTransfersDel.$transfer;
			$handle = false;
			$handle = @fopen($file, "w");
			if (!$handle) {
	            $msg = "cannot open file ".$file." for writing.";
	            array_push($this->messages , $msg);
	            AuditAction($cfg["constants"]["error"], "FluAzu instance_delTransfer-Error : ".$msg);
				return false;
			}
	        $result = @fwrite($handle, $cfg['user']);
			@fclose($handle);
			if ($result === false) {
	            $msg = "cannot write content to file ".$file.".";
	            array_push($this->messages , $msg);
	            AuditAction($cfg["constants"]["error"], "FluAzu instance_delTransfer-Error : ".$msg);
				return false;
			}
			// send reload-command
			$this->instance_addCommand('r', true);
			// wait until file is gone (fluazu has processed the request)
            $maxLoops = 75;
            $loopCtr = 0;
            for (;;) {
            	@clearstatcache();
            	if ($this->instance_transferExists($transfer)) {
	            	$loopCtr++;
	            	if ($loopCtr > $maxLoops) {
						$msg = "fluazu did not delete transfer ".$transfer." after ".($maxLoops / 5)." seconds, giving up";
						array_push($this->messages , $msg);
						AuditAction($cfg["constants"]["error"], "FluAzu instance_delTransfer-Error : ".$msg);
	            		return false;
	            	} else {
	            		usleep(200000); // wait for 0.2 seconds
	            	}
            	} else {
            		// give fluazu another second before returning
            		sleep(1);
            		// return
            		return true;
            	}
            }
        } else {
        	$msg = "fluazu not running, cannot delete transfer ".$transfer;
        	AuditAction($cfg["constants"]["error"], $msg);
        	array_push($this->messages , $msg);
            // Set the state
            $this->state = FLUAZU_STATE_ERROR;
			return false;
        }
    }

    /**
     * transfer exists
     *
     * @param $transfer
     * @return boolean
     */
    function instance_transferExists($transfer) {
    	return file_exists($this->_pathTransfers.$transfer);
    }

    /**
     * get status
     *
     * @return array
     */
    function instance_getStatus() {
    	$keys = $this->instance_getStatusKeys();
    	$retVal = array();
    	if ($this->state == FLUAZU_STATE_RUNNING) {
    		$data = @file_get_contents($this->_pathStatFile);
	        $content = @explode("\n", $data);
	        $count = count($keys);
	        if (is_array($content) && (count($content) >= $count)) {
	        	$content = array_map('trim', $content);
		    	for ($i = 0; $i < $count; $i++)
					$retVal[$keys[$i]] = $content[$i];
	        	return $retVal;
	        }
    	}
    	foreach ($keys as $key)
			$retVal[$key] = 0;
    	return $retVal;
    }

    /**
     * get status-keys
     *
     * @return array
     */
    function instance_getStatusKeys() {
    	return array(
    		'azu_host',
    		'azu_port',
    		'azu_version',
    		'CORE_PARAM_INT_MAX_ACTIVE',
    		'CORE_PARAM_INT_MAX_ACTIVE_SEEDING',
    		'CORE_PARAM_INT_MAX_CONNECTIONS_GLOBAL',
    		'CORE_PARAM_INT_MAX_CONNECTIONS_PER_TORRENT',
    		'CORE_PARAM_INT_MAX_DOWNLOAD_SPEED_KBYTES_PER_SEC',
    		'CORE_PARAM_INT_MAX_DOWNLOADS',
    		'CORE_PARAM_INT_MAX_UPLOAD_SPEED_KBYTES_PER_SEC',
    		'CORE_PARAM_INT_MAX_UPLOAD_SPEED_SEEDING_KBYTES_PER_SEC',
    		'CORE_PARAM_INT_MAX_UPLOADS',
    		'CORE_PARAM_INT_MAX_UPLOADS_SEEDING'
    	);
    }

    /**
     * set global upload rate
     *
     * @param $uprate
     * @param $autosend
     */
    function instance_setRateUpload($uprate, $autosend = false) {
    	$this->instance_setAzu('CORE_PARAM_INT_MAX_UPLOAD_SPEED_KBYTES_PER_SEC', $uprate, $autosend);
    }

    /**
     * set global download rate
     *
     * @param $downrate
     * @param $autosend
     */
    function instance_setRateDownload($downrate, $autosend = false) {
    	$this->instance_setAzu('CORE_PARAM_INT_MAX_DOWNLOAD_SPEED_KBYTES_PER_SEC', $downrate, $autosend);
    }

    /**
     * set a azu-setting
     *
     * @param $key
     * @param $val
     * @param $autosend
     */
    function instance_setAzu($key, $val, $autosend = false) {
    	$this->instance_addCommand('s'.$key.':'.$val, $autosend);
    }

    // =========================================================================
	// private methods
	// =========================================================================

    /**
     * log a message
     *
     * @param $logFile
     * @param $message
     * @param $withTS
     * @return boolean
     */
    function _log($logFile, $message, $withTS = false) {
    	$content = "";
    	if ($withTS)
    		$content .= @date("[Y/m/d - H:i:s]");
    	$content .= '[FRONTEND] ';
    	$content .= $message;
		$fp = false;
		$fp = @fopen($logFile, "a+");
		if (!$fp)
			return false;
		$result = @fwrite($fp, $content);
		@fclose($fp);
		if ($result === false)
			return false;
		return true;
    }

     /**
     * write the command-file
     *
	 * @param $content
     * @return boolean
     */
	function _writeCommandFile($content) {
		global $cfg;
		$handle = false;
		$handle = @fopen($this->_pathCommandFile, "w");
		if (!$handle) {
            $msg = "cannot open command-file ".$this->_pathCommandFile." for writing.";
            array_push($this->messages , $msg);
            AuditAction($cfg["constants"]["error"], "FluAzu _writeCommandFile-Error : ".$msg);
			return false;
		}
        $result = @fwrite($handle, $content);
		@fclose($handle);
		if ($result === false) {
            $msg = "cannot write content to command-file ".$this->_pathCommandFile.".";
            array_push($this->messages , $msg);
            AuditAction($cfg["constants"]["error"], "FluAzu _writeCommandFile-Error : ".$msg);
			return false;
		}
		return true;
    }

}

?>