opendrive/opendrive.php

<?php

# Debug
$DEBUG = 0;
if ($_ENV['DEBUG']) {
	$DEBUG = intval($_ENV['DEBUG']);
	if (!$DEBUG) {
		$DEBUG = 1;
	}
}

# On-disk config (unless we already have it)
if (!isset($OD_USER) || !isset($OD_PASSWD) || !isset($DB_STRING)) {
	@include_once '.secrets';
}

# Config
global $API_BASE;
global $API_VERSION;
global $API_CHUNK_SIZE;
$API_BASE = 'https://dev.opendrive.com/api/v1';
$API_VERSION = 10;
$API_CHUNK_SIZE = 250 * 1024 * 1024;

# PHP version support
if (!function_exists('curl_file_create')) {
	function curl_file_create($filename, $mimetype = '', $postname = '') {
		return '@' . $filename . ';filename=' .
		($postname ?: basename($filename)) .
		($mimetype ? ';type=' . $mimetype : '');
	}
}

# Open the DB connection
function dbOpen() {
	global $DB_STRING;
	global $DB_USER;
	global $DB_PASSWD;

	# Sanity check
	if (!isset($DB_STRING)) {
		die("No DBN in available\n");
	}

	# Connect
	try {
		$dbh = new PDO($DB_STRING, $DB_USER, $DB_PASSWD);
	} catch (PDOException $e) {
		die('DB error: ' . $e->getMessage() . "\n");
	}
	return $dbh;
}

# Cleanup a path for better matching at OpenDrive
function pathCleanup($path) {
	$path = preg_replace('/\/+$/', '', $path);
	$path = preg_replace('/^\/+/', '', $path);
	return $path;
}

# Return the clean parent path of a provided path
function parentPath($path) {
	return dirname(pathCleanup($path));
}

# Return the clean base name of a provided path
function basePath($path) {
	return basename(pathCleanup($path));
}

function curlPostRaw($url, $data, $header = NULL) {
	global $API_BASE;
	global $CA_PATH;
	global $DEBUG;

	# Setup cURL
	$ch = curl_init($API_BASE . $url);
	curl_setopt_array($ch, array(
		CURLOPT_CAINFO => $CA_PATH,
		CURLOPT_POST => true,
		CURLOPT_RETURNTRANSFER => true,
		CURLOPT_POSTFIELDS => $data
	));
	if ($DEBUG >= 3) {
		curl_setopt($ch, CURLOPT_VERBOSE, true);
	}
	if ($header != NULL) {
		if (!is_array($header)) {
			$header = array($header);
		}
		curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
	}

	# Send the request
	if ($DEBUG >= 2) {
		echo 'Request: ' . $url . "\n";
		print_r($data);
		echo "\n\n";
	}
	$response = curl_exec($ch);

	# Check for errors
	if ($response === FALSE){
	    die(curl_error($ch));
	}

	# Return
	if ($DEBUG >= 4) {
		echo "Response headers:\n";
		print_r(curl_getinfo($ch));
		echo "Response body:\n";
		print_r($response);
		echo "\n\n======================================\n\n\n";
	}
	return($response);
}

# POST the provided data to OpenDrive
function curlPost($url, $data) {
	$data = json_encode($data);
	$response = curlPostRaw($url, $data, 'Content-Type: application/json');
	$responseData = json_decode($response, true);
	if ($DEBUG >= 3) {
		echo "Response Data:\n";
		print_r($responseData);
	}
	return($responseData);
}

# GET from OpenDrive
function curlGet($url) {
	global $API_BASE;
	global $CA_PATH;
	global $DEBUG;

	# Setup cURL
	$ch = curl_init($API_BASE . $url);
	curl_setopt_array($ch, array(
		CURLOPT_CAINFO => $CA_PATH,
		CURLOPT_RETURNTRANSFER => true
	));
	if ($DEBUG >= 3) {
		curl_setopt($ch, CURLOPT_VERBOSE, true);
	}

	# Send the request
	if ($DEBUG >= 2) {
		echo 'Request: ' . $url . "\n";
		print_r($data);
		echo "\n";
	}
	$response = curl_exec($ch);

	# Check for errors
	if ($response === FALSE){
	    die(curl_error($ch));
	}

	# Return
	$responseData = json_decode($response, true);
	return($responseData);
}

# Login to OD and return the SessionID
function login() {
	global $API_VERSION;
	global $OD_USER;
	global $OD_PASSWD;

	# Sanity check
	if (!isset($OD_USER) || !isset($OD_PASSWD)) {
		die("No OpenDrive credentials available\n");
	}

	# Login
	$data = array(
		'username' 	=> $OD_USER,
		'passwd'	=> $OD_PASSWD,
		'version'	=> $API_VERSION
	);
	$response = curlPost('/session/login.json', $data);

	# Check the result
	if ($response['SessionID']) {
		return $response['SessionID'];
	}
	return false;
}

# Logout of OpenDrive
function logout($session) {
	$data = array(
		'session_id'	=> $session
	);
	$response = curlPost('/session/logout.json', $data);

	# Check the result
	if ($response['result'] == 'true') {
		return true;
	}
	return false;
}

# Return the ID of a folder
function folderID($session, $path) {
	$data = array(
		'session_id'	=> $session,
		'path'		=> $path
	);
	$response = curlPost('/folder/idbypath.json', $data);

	# Check the result
	if ($response['FolderId']) {
		return($response['FolderId']);
	}
	return false;
}

# Find the parent ID for a given path
function parentID($session, $path) {
	$parent = parentPath($path);

	$parentID = 0;
	if ($parent != '.') {
		$parentID = folderID($session, $parent);
	}
	return $parentID;
}

# Create a folder
function mkFolder($session, $path) {
	global $DEBUG;

	# Find the parent ID (if any)
	$parentID = parentID($session, $path);
	if ($parentID === false) {
		if ($DEBUG) {
			echo 'Invalid parent for path: ' . $path . "\n";
		}
		return false;
	}

	# POST
	$data = array(
		'session_id'		=> $session,
		'folder_name'		=> basePath($path),
		'folder_sub_parent'	=> $parentID,
		'folder_is_public'	=> 0
	);
	$response = curlPost('/folder.json', $data);

	# Check the result
	if ($response['FolderId']) {
		return($response['FolderId']);
	}
	return false;
}

# Trash a folder
function rmFolder($session, $path) {
	$id = folderID($session, $path);
	if (!$id) {
		return false;
	}

	$data = array(
		'session_id'	=> $session,
		'folder_id'	=> $id
	);
	$response = curlPost('/folder/trash.json', $data);

	# Check the result
	if ($response['DirUpdateTime']) {
		return true;
	}
	return false;
}

# Return the ID of a file
function fileID($session, $path) {
	$data = array(
		'session_id'	=> $session,
		'path'		=> $path
	);
	$response = curlPost('/file/idbypath.json', $data);

	# Check the result
	if ($response['FileId']) {
		return($response['FileId']);
	}
	return false;
}

# Return all file metadata
function fileInfo($session, $path) {
	$id = fileID($session, $path);
	if (!$id) {
		return false;
	}

	# GET
	$response = curlGet('/file/info.json/' . $session . '/' . $id);

	# Check the result
	if ($response['FileId']) {
		return($response);
	}
	return false;
}

# Upload the provided file to the given path
function fileUpload($session, $path, $file) {
	global $DEBUG;
	global $API_CHUNK_SIZE;

	# Find the local file
	$stat = @stat($file);
	if ($stat === false) {
		if ($DEBUG) {
			echo 'Unable to stat: ' . $file . "\n";
		}
		return false;
	}

	# Find the parent ID
	$parentID = parentID($session, $path);
	if ($parentID === false) {
		if ($DEBUG) {
			echo 'No parent for path: ' . $path . "\n";
		}
		return false;
	}

	# Allocate
	$data = array(
		'session_id'	=> $session,
		'folder_id'	=> $parentID,
		'file_name'	=> basePath($path),
		'file_size'	=> $stat['size']
	);
	$response = curlPost('/upload/create_file.json', $data);
	$id = $response['FileId'];
	if (!$id) {
		if ($DEBUG) {
			echo 'Unable to allocate: ' . $path . "\n";
		}
		return false;
	}

	# Open
	$data = array(
		'session_id'	=> $session,
		'file_id'	=> $id,
		'file_size'	=> $stat['size']
	);
	$response = curlPost('/upload/open_file_upload.json', $data);
	$tmpPath = $response['TempLocation'];
	if (!$tmpPath) {
		if ($DEBUG) {
			echo 'Unable to open: ' . $path . "\n";
		}
		return false;
	}

	# Split if needed
	$tempDir = false;
	$files = array();
	if ($stat['size'] > $API_CHUNK_SIZE) {
		if ($DEBUG) {
			echo 'Splitting file: ' . $file . ' (' . $API_CHUNK_SIZE . '/' . $stat['size'] . ")\n";
		}

		# Create a temporary directory
		$tempDir = trim(
			shell_exec(
				'mktemp' .
				' -d' .
				' --tmpdir=' . escapeshellarg(sys_get_temp_dir()) .
				' ' . escapeshellarg(basename($file)) . '.XXXXXXXX'
			)
		);
		if (!is_dir($tempDir)) {
			echo "Unable to create temp directory\n";
			return false;
		}

		# Split into chunk-sized parts
		shell_exec('cd ' . escapeshellarg($tempDir) .
			' && split -b ' . escapeshellarg($API_CHUNK_SIZE) . ' ' . escapeshellarg($file));

		# Find all their paths
		$fh = opendir($tempDir);
		if (!$fh) {
			echo 'Unable to open temp directory: ' . $tempDir . "\n";
			return false;
		}
		while (($chunk = readdir($fh)) !== false) {
			if (preg_match('/^x\w+$/', $chunk)) {
				$files[] = $tempDir . '/' . $chunk;
			}
		}
		unset($chunk);

		# Cleanup
		closedir($fh);
		unset($fh);
	} else {
		$files[] = $file;
	}

	# Sort the list to ensure the chunks are uploaded in order
	sort($files);

	# Upload
	$offset = 0;
	if (count($files) < 1) {
		echo 'No segments to upload: ' . $file . "\n";
		return false;
	}
	foreach ($files as $chunk) {
		if ($DEBUG > 1) {
			echo 'Uploading chunk: ' . $chunk . "\n";
		}

		# Find the chunk size
		$chunkStat = @stat($chunk);
		if ($chunkStat === false) {
			echo 'Unable to stat chunk: ' . $chunk . "\n";
			return false;
		}

		# Setup cURL
		$cfile = curl_file_create($chunk, 'application/octet-stream', basePath($file));
		$data = array(
			'session_id'	=> $session,
			'file_id'	=> $id,
			'temp_location'	=> $tmpPath,
			'chunk_offset'	=> $offset,
			'chunk_size'	=> $chunkStat['size'],
			'file_data'	=> $cfile
		);

		# Upload
		$response = curlPostRaw('/upload/upload_file_chunk.json', $data, 'Expect:');
		if ($response) {
			$response = json_decode($response, true);
		}
		if (!$response || $response['TotalWritten'] != $chunkStat['size']) {
			echo 'Unable to upload: ' . $chunk . "\n";
			return false;
		}

		# Remove chunks as we use them
		if ($tempDir) {
			unlink($chunk);
		}

		# Increment the offset
		$offset += $chunkStat['size'];
		unset($chunkStat);
		unset($response);
	}
	unset($offset);

	# Remove the temporary directory, if it exists
	if ($tempDir && is_dir($tempDir)) {
		rmdir($tempDir);
	}
	unset($tempDir);

	# Close
	$data = array(
		'session_id'	=> $session,
		'file_id'	=> $id,
		'temp_location'	=> $tmpPath,
		'file_time'	=> $stat['mtime'],
		'file_size'	=> $stat['size']
	);
	$response = curlPost('/upload/close_file_upload.json', $data);
	if (!$response || $response['Size'] != $stat['size']) {
		if ($DEBUG) {
			echo 'Unable to close: ' . $path . "\n";
		}
		return false;
	}

	# Return the file size on success
	return $stat['size'];
}

?>