pushRestore.sh

#!/bin/bash
#######################################################################################
#
# pushRestore.sh [sourceComputer] [destComputer] [restorePath] [getDirs] [getFiles]
#
# Example:
#    pushRestore.sh 'COMP1' 'COMP2' '/tmp/restore' '/tmp/dir1,/tmp/dir 2' '/tmp/file1,/tmp/file 2'
#
# This example script performs an automated Push Restore (via REST):
#  * One or more source files/directories.
#  * To local or remote destination computer.  To remote directory of choice.
#  * Using MPC or Cloud storage.
#  * Recursive restore (includes subdirectories).
#  * Between computers of different users (if Admin).
#  * ...and more.
#
# Edit the variables near the top of this script, or pass in optional args. 
#
# Notes:
#  * Push destination should be running authenticated Crashplan client.
#  * Archive adoption (or original owner) not requried.
# 
# Author: Marc Johnson, Code 42 Software
# Last Modified: 09-19-2016 by Jack Phinney, Code42 Software 
# 
# --------
#
# # Copyright (c) 2016 Code42, Inc.
# Permission is hereby granted, free of charge, to any person obtaining a copy 
# of this software and associated documentation files (the "Software"), to deal 
# in the Software without restriction, including without limitation the rights 
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
# copies of the Software, and to permit persons to whom the Software is 
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in all 
# copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
# SOFTWARE.
#######################################################################################


###################################
# Local Variables (customize)
###################################

# PROe Master Server (e.g. http/4280 or https/4285)
MASTER='http://192.168.0.11:4280' 

# Restore credentials 
CPLOGIN='admin:admin00' 

# Computers (both can be remote and different)
sourceComputer=C02HT6EGF57J
destComputer=C02HT6EGF57J

# Where on destination computer to restore
restorePath='/tmp/mjohnson'

# Add any number of Files or Directories.
# Restore still works if some not in archive.
# Note that Windows systems need "C:/" prepended
getDirs=(
	"/Users/mjohnson/Documents/test"
	"/Users/mjohnson/Documents/Scratch Projects"
)
# getFiles=(
#	"/Users/mjohnson/Desktop/test.pdf" 
#	"/Users/mjohnson/Desktop/test2.pdf"  
#	"/Users/mjohnson/Desktop/test3.pdf"
#)
# Timeout limit for Web Restore
TIMEOUT=900 #seconds

# Flag to move restored files out of container restore directory.
# Performs additional status monitoring.  Currently only works 
# if script running on destination + MPC.  See below.
DOMOVE=false

###################################
# Utilize Optional Commandline Args if Present 
# [sourceComputer] [destComputer] [restorePath] [getDirs] [getFiles]
###################################

sourceComputer=${1:-$sourceComputer} 
destComputer=${2:-$destComputer} 
restorePath=${3:-$restorePath} 
OLD_IFS=$IFS
IFS=','
if [ -n "$4" ]; then
	getDirs=($4) 
fi
if [ -n "$5" ]; then
	getFiles=($5) 
fi
IFS=$OLD_IFS

###################################
# Helper Functions 
###################################

# API Get
function api {
	echo `curl -sku $CPLOGIN --header "Accept: application/json" "$MASTER/api/${1}?${2}"`
}

# API Post
function apiPost {
	echo `curl -sku $CPLOGIN --header "Content-Type: application/json" -X POST -d "${2}" "$MASTER/api/${1}"`
}

# Json value for given key
function jsonValue {
	echo "${2}" | grep "${1}" | sed 's/^.*"'${1}'":"\([^"]*\)".*$/\1/'
}

###################################
# Setup Session
###################################

echo "Setting up Session..."

# Get source computer info
JSON=`api Computer 'q="'${sourceComputer}'"&incBackupUsage=true&active=true'`
sourceGuid=`jsonValue guid "${JSON}"`
serverName=`jsonValue serverName "${JSON}"`

# If provider node
if [[ "${serverName}" == *ProviderNode* ]]; then
	echo "Detected Public Cloud storage source..."
	destGuid=`echo ${JSON} | python -mjson.tool | grep serverGuid | cut -d'"' -f4`
else
	# Get destination data is stored on
	echo "Detected MPC storage source..."
	JSON=`api Server 'q="'${serverName}'"'`
	destGuid=`jsonValue guid "${JSON}"`
fi

# Get accepting computer guid
JSON=`api Computer 'q="'${destComputer}'"&active=true'`
acceptingGuid=`jsonValue guid "${JSON}"`

echo "Getting Data Key Token..."

# Get Data Key Token
DATA='{"computerGuid":'${sourceGuid}'}'
JSON=`apiPost DataKeyToken "${DATA}"`
dataKeyToken=`jsonValue dataKeyToken "${JSON}"` 

# Get Web Restore Session Id
DATA='{"computerGuid":"'${sourceGuid}'", "dataKeyToken":"'${dataKeyToken}'" }'
JSON=`apiPost WebRestoreSession "${DATA}"`
webRestoreSessionId=`jsonValue webRestoreSessionId "${JSON}"`

###################################
# Build Push Restore
###################################

# Display status and build request
echo "Requesting restore from ${sourceComputer}:"
for var in "${getDirs[@]}" 
do
  echo "			${var}"
  pathJSON=${pathJSON}'{"type":"directory", "path":"'"${var}"'","selected":true},'
done
for var in "${getFiles[@]}" 
do
  echo "			${var}"
  pathJSON=${pathJSON}'{"type":"file", "path":"'"${var}"'","selected":true},'
done
pathJSON="${pathJSON%?}" #remove trailing comma
echo "...Pushed to ${restorePath} on ${destComputer}"

# Payload to POST
DATA='		{ 
		    "webRestoreSessionId":"'${webRestoreSessionId}'", 
		    "sourceGuid":"'${sourceGuid}'", 
		    "targetNodeGuid":"'${destGuid}'", 
		    "acceptingGuid":"'${acceptingGuid}'", 
		    "restorePath":"'"${restorePath}"'",
		    "pathSet":[
		    	'${pathJSON}'
		    ], 
		    "numBytes":1, 
		    "numFiles":1, 
		    "showDeleted":true, 
		    "restoreFullPath":true 
		}'

###################################
# Push Restore
###################################
JSON=`apiPost PushRestoreJob "${DATA}"`
restoreId=`jsonValue restoreId "${JSON}"`

###################################
# Result
###################################
echo
echo "Request / POST: 			${DATA}"
echo 
echo "Response from Server: 	${JSON}"
echo
if [ -z "${restoreId}" ]
then
	echo "Push Restore NOT successful."
	exit
else
	echo "Push Restore successfully submitted and accepted."
	echo "In progress... may take a few minutes."
	echo "Restored files in ${restorePath}"
fi

#################################################
# PERFORM LOCAL MOVE if flag set:
# Move restored files out of container directory.  
# Perform additional status monitoring. 
# Script must be running on destination + MPC.
#################################################
if [ "${DOMOVE}" == "true" ];
then

	###################################
	# Watch RestoreRecord
	###################################
	echo
	echo -n "Monitoring restore progress"
	counter=0
	until [ -z "${JSON}" ] || [[ ${counter} -gt ${TIMEOUT} ]]; do
			sleep 1
		counter=$((counter + 1)) 
		JSON=`api "RestoreRecord/${restoreId}" | grep "not found"`
		echo -n .
	done
	echo

	###################################
	# Move to destination directory
	###################################
	JSON=`api "RestoreRecord/${restoreId}"`
	completedDate=`jsonValue completedDate "${JSON}"`

	if [ -z "${completedDate}" ]
	then
		echo "Push Restore NOT successful.  Timed out."
	else
		echo "Push Restore completed successfully."
		restoreDir=`ls -tr ${restorePath} | grep crashplan-restore | tail -n 1` # todo: timiestamp testing
		if [ -z "${restoreDir}" ]
		then
			echo "Could not find Restore diretory."
		else
			echo "Contents of Restore directory:"
			restoreDir=${restorePath}/${restoreDir}
			find ${restoreDir} | sed s:"${restoreDir}"::

			# move out of temporary container folder (prompt for overwrite)
			sudo mv -i ${restoreDir}/* ${restorePath}
			# sudo rm -rf ${restoreDir}       # optional cleanup temp folder		
			exit
		fi
	fi	
fi