#!/bin/sh
#
# wcgresults - use WCG's API to get a list of recent results
# https://www.worldcommunitygrid.org/help/viewTopic.do?shortName=api
#
#	VERSION: 1.8.3
#	Author: Adri Verhoef

Prog=${0##*/}

#############
# CONFIGURE #
#############
TMPDIR=/var/tmp					# Directory for storing temporary files
URLBASE=https://www.worldcommunitygrid.org	# Don't change this, unless you know what you're doing
MEMBER="youraccountname"	# The name of your account with which you're crunching
VERIFY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" # Your verification code on 'My Profile'
MEMBER1="anotheraccount"
VERIFY1="11111111111111111111111111111111"
########################
# END OF CONFIGURATION #
########################

usage () {
	printf "%s\n" \
		"Usage: $Prog [options] [-d | file ...]" \
		" Options:" \
		"  -b sortby     sort results by the value of ’sortby’" \
		"                (0 = DeviceId, 1 = SentTime, 2 = ReportDeadline, 3 = ReceivedTime (default), 4 = CpuTime)" \
		"  -d            download a new status file before calculating averages" \
		"  -f logfile    record results that went through the validator to file ’logfile’" \
		"  -l limit      define the number of results to download (default: 250)" \
		"  -o offset     define the number of results to skip when downloading (default: 0)" \
		"  -s state      only select results with ”ValidateState” value ’state’" \
		"                (0 = pending validation, 1 = valid, 2 = invalid," \
		"                 4 = pending verification, 5 = results failed to validate within given deadline)" \
		"  -u user       the name of your account on World Community Grid (default: you; ’user’ = 1 ... for other account(s))" \
		"  -w            only select results that are still 'in progress'" \
		;
}

# Options
OPTS=hb:df:l:o:s:u:w
export opt_b=3		# latest received
export opt_d=0
export opt_f=""
export opt_l=250
export opt_o=0
export opt_s=""
export opt_u=""
export opt_w=0
while getopts $OPTS opt; do
	case $opt in
		h)	usage; exit 0;;
		[dw])	eval let opt_$opt++;;
		[a-zA-Z0-9])	eval opt_$opt='$OPTARG';;
		?)	usage; exit 1;;
	esac
done
shift $(($OPTIND - 1))

case $opt_b in [01234]) case $opt_b in 0) opt_b=DeviceId;; 1) opt_b=SentTime;; 2) opt_b=ReportDeadline;; 3) opt_b=ReceivedTime;; 4) opt_b=CpuTime;; esac; SortBy="&SortBy=$opt_b";; *) SortBy="";; esac
case $opt_o in 0) Offset="";; *) Offset="&Offset=$opt_o";; esac
case $opt_s in [01245]) ValidateState="&ValidateState=$opt_s";; *) ValidateState="";; esac
case $opt_u in "") ;; *) eval MEMBER=\$MEMBER$opt_u; eval VERIFY=\$VERIFY$opt_u;; esac
case $opt_w in 0) ServerState=5;; *) ServerState=4;; esac

TMPFILE=$TMPDIR/$Prog.`date +%Y-%m-%dT%H:%M:%S`

PRINT_LONG_FORMAT='
	printf "%-20s %6d", $str_ValidateState[$ValidateState], $combi_DeviceName_AppName_ValidateState_count{$DeviceName}{$AppName}{$ValidateState};
	printf " %6.1f", $cc=($combi_DeviceName_AppName_ValidateState_ClaimedCredit{$DeviceName}{$AppName}{$ValidateState} / $combi_DeviceName_AppName_ValidateState_count{$DeviceName}{$AppName}{$ValidateState});
	printf "/%-6.1f", $g=($combi_DeviceName_AppName_ValidateState_GrantedCredit{$DeviceName}{$AppName}{$ValidateState} / $combi_DeviceName_AppName_ValidateState_count{$DeviceName}{$AppName}{$ValidateState});
	printf " %7.2f", $ct=($combi_DeviceName_AppName_ValidateState_CpuTime{$DeviceName}{$AppName}{$ValidateState} / $combi_DeviceName_AppName_ValidateState_count{$DeviceName}{$AppName}{$ValidateState});
	printf "/%-7.2f", $combi_DeviceName_AppName_ValidateState_ElapsedTime{$DeviceName}{$AppName}{$ValidateState} / $combi_DeviceName_AppName_ValidateState_count{$DeviceName}{$AppName}{$ValidateState};
	printf "\n";
'
ADDITIONAL_HEADER='(ValidationState)           (Claim/Grant)    (Cpu/Elapsed)'
PRINT_LONG_HEADER='
	printf "%-16s %-6s %4d\t'"$ADDITIONAL_HEADER"'\n", $DeviceName, $AppName, $combi_DeviceName_AppName{$DeviceName}{$AppName};
'

calculate_or_record () {
perl -wne '
	BEGIN {
		if ($ENV{opt_f} ne "") {
			if (open(LOGFILE, $ENV{opt_f})) {
				while (<LOGFILE>) {
					chomp;
					@t = split(/\t/);
					$workunit{$t[9]} = $t[15]; # Name and ValidateState
				}
				close(LOGFILE);
			}
			open(LOGFILE, ">>$ENV{opt_f}") || die "$ENV{Prog}: cannot open logfile ’$ENV{opt_f}’ for writing.\n";
		}
		$outcome_varies = 0;
		$str_Outcome[0] = "(waiting)"; # in progress
		$str_Outcome[1] = "success";
		$str_Outcome[3] = "error";
		$str_Outcome[4] = "no reply";
		$str_Outcome[6] = "validation error";
		$str_Outcome[7] = "abandoned";
		$str_ValidateState[0] = "Pending validation";
		$str_ValidateState[1] = "Valid";
		$str_ValidateState[2] = "Invalid";
		$str_ValidateState[3] = "In progress"; # originally undefined state, so it is now a user defined value
		$str_ValidateState[4] = "Pending verification";
		$str_ValidateState[5] = "Too late";
		#str_ExitStatus[192] = "EXIT_STATEFILE_WRITE";
		$txt_ExitStatus[192] = "The client will exit if it cannot write to the client_state.xml file. Make sure you have permission to write to the BOINC Data directory.";
		#str_ExitStatus[193] = "EXIT_SIGNAL";
		$txt_ExitStatus[193] = "The client, Manager and/or application will exit when getting the exit signal.";
		#str_ExitStatus[194] = "EXIT_ABORTED_BY_CLIENT";
		$txt_ExitStatus[194] = "Task was aborted by the BOINC client.";
		#str_ExitStatus[195] = "EXIT_CHILD_FAILED";
		$txt_ExitStatus[195] = "The science application running the task failed for unknown reasons.";
		#str_ExitStatus[196] = "EXIT_DISK_LIMIT_EXCEEDED";
		$txt_ExitStatus[196] = "The amount of disk space that the task could use was more than the limit set to the task.";
		#str_ExitStatus[197] = "EXIT_TIME_LIMIT_EXCEEDED";
		$txt_ExitStatus[197] = "The amount of time that the task can run was estimated to be far greater than the time limit set to the task.";
		#str_ExitStatus[198] = "EXIT_MEM_LIMIT_EXCEEDED";
		$txt_ExitStatus[198] = "The amount of memory that the task could use was greater than the limit set to the task.";
		#str_ExitStatus[199] = "EXIT_CLIENT_EXITING";
		$txt_ExitStatus[199] = "The task was ended when the client was exited.";
		#str_ExitStatus[200] = "EXIT_UNSTARTED_LATE";
		$txt_ExitStatus[200] = "Task was aborted due to it having not started and already past the deadline.";
		#str_ExitStatus[201] = "EXIT_MISSING_COPROC";
		$txt_ExitStatus[201] = "A coprocessor that was detected earlier went missing. Work for it is being aborted.";
		#str_ExitStatus[202] = "EXIT_ABORTED_BY_PROJECT";
		$txt_ExitStatus[202] = "Tasks on the computer were aborted by the project.";
		#str_ExitStatus[203] = "EXIT_ABORTED_VIA_GUI";
		$txt_ExitStatus[203] = "Applications exit with this code after you told them to abort.";
		#str_ExitStatus[204] = "EXIT_UNKNOWN";
		$txt_ExitStatus[204] = "Unknown exit.";
		$results_available = 0;
	}
	chomp;
	if (/"ResultsReturned": "([^"]+)",/) { print "Results returned: $1\n" unless $ENV{opt_f} ne ""; }
	elsif (/"AppName": "([^"]+)",/) { $AppName = $1; }
	elsif (/"ClaimedCredit": ([^,]+)/) { $ClaimedCredit = $1; }
	elsif (/"CpuTime": ([^,]+)/) { $CpuTime = $1; }
	elsif (/"ElapsedTime": ([^,]+)/) { $ElapsedTime = $1; }
	elsif (/"ExitStatus": ([^,]+)/) { $ExitStatus = $1; }
	elsif (/"GrantedCredit": ([^,]+)/) { $GrantedCredit = $1; }
	elsif (/"DeviceId": ([^,]+)/) { $DeviceId = $1; }			# only used for LOGFILE
	elsif (/"DeviceName": "([^"]+)",/) { $DeviceName = $1; }
	elsif (/"ModTime": ([^,]+)/) { $ModTime = $1; }				# only used for LOGFILE
	elsif (/"Name": "([^"]+)",/) { $Name = $1; }
	elsif (/"Outcome": ([^,]+)/) { $Outcome = $1; }
	elsif (/"ReceivedTime": "([^"]+)",/) { $ReceivedTime = $1; }		# only used for LOGFILE
	elsif (/"ReportDeadline": "([^"]+)",/) { $ReportDeadline = $1; }	# only used for LOGFILE
	elsif (/"SentTime": "([^"]+)",/) { $SentTime = $1; }			# only used for LOGFILE
	elsif (/"ServerState": ([^,]+)/) { $ServerState = $1; }
	elsif (/"ValidateState": ([^,]+)/) { $ValidateState = $1; }
	elsif (/"FileDeleteState": ([^,]+)/) { $FileDeleteState = $1; }		# only used for LOGFILE
	if (/"([^"]+)": ("([^"]+)"|[0-9]+(\.[0-9]+)?)$/) { # last item in record, line not ending in comma
		if ($ENV{opt_f} ne "") {
			# ServerState == 5: results that have already been reported back to the server
			# ValidateState == 0: pending validation
			# ValidateState == 4: pending verification
			if ($ServerState == 5 && $ValidateState != 0 && $ValidateState != 4) {
				if (exists $workunit{$Name}) {
					if ($workunit{$Name} != $ValidateState) {
						print STDERR "$Name has its ValidateState changed from $workunit{$Name} to $ValidateState\n"; # Hopefully changed from ”Too Late” into something better.
					} else {
						next; # already recorded in LOGFILE
					}
				}
				next if $ClaimedCredit + $CpuTime + $ElapsedTime + $GrantedCredit == 0.0; # probably: 192 <= $ExitStatus <= 204
				printf LOGFILE "%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\n", $AppName, $ClaimedCredit, $CpuTime, $ElapsedTime, $ExitStatus, $GrantedCredit, $DeviceId, $DeviceName, $ModTime, $Name, $Outcome, $ReceivedTime, $ReportDeadline, $SentTime, $ServerState, $ValidateState, $FileDeleteState;
			}
		} else {
			if ($Outcome != 1) {
				if ($Outcome == 0) {
					$ValidateState = 3; # In progress
					$ExitStatus = "-";
				} else {
					$results_available = 1;
				}
				$fmt0 = "%-16s %-4s %-9s %-20s %-6s";
				$fmt1 = "%s    %s";
				$fmt2 = "%6.1f/%-6.1f %7.2f/%-7.2f ";
				$fmt3 = "   %s\n";
				printf "$fmt0 $fmt1$fmt3", "(DeviceName)", "App", "(Outcome)", "(ValidationState)", "(Exit)", "(Claim/Grant)", "(Cpu/Elapsed)", "(Name)" if ++$outcome_varies == 1;
				if ($ExitStatus ne "-") {
					if ($ExitStatus >= 192 && $ExitStatus <= 204) {
						if (not exists $DidExitStatus[$ExitStatus]) {
							$DidExitStatus[$ExitStatus] = 1;
							printf "\tExitStatus $ExitStatus: $txt_ExitStatus[$ExitStatus]\n";
						}
					}
				}
				printf "$fmt0 $fmt2$fmt3", $DeviceName, $AppName, $str_Outcome[$Outcome], $str_ValidateState[$ValidateState], $ExitStatus, $ClaimedCredit, $GrantedCredit, $CpuTime, $ElapsedTime, $Name;
			}
			if ($ServerState == 5) {
				$results_available = 1;
				# results that have already been reported back to the server
				$combi_DeviceName_AppName{$DeviceName}{$AppName}++;
				$combi_DeviceName_AppName_ValidateState_count{$DeviceName}{$AppName}{$ValidateState}++; # number of validated results
				$combi_DeviceName_AppName_ValidateState_ClaimedCredit{$DeviceName}{$AppName}{$ValidateState} += $ClaimedCredit;
				$combi_DeviceName_AppName_ValidateState_CpuTime{$DeviceName}{$AppName}{$ValidateState} += $CpuTime;
				$combi_DeviceName_AppName_ValidateState_ElapsedTime{$DeviceName}{$AppName}{$ValidateState} += $ElapsedTime;
				$combi_DeviceName_AppName_ValidateState_GrantedCredit{$DeviceName}{$AppName}{$ValidateState} += $GrantedCredit;
			}
		}
	}
	END {
		if ($results_available > 0) {
			printf "%s %s %-6s %s %s\n", "=" x 16, " " x 4, " (Number)", " " x 20, "(Number)" if $outcome_varies > 0;
			foreach $DeviceName (keys %combi_DeviceName_AppName) {
				#print "$DeviceName:\n";
				foreach $AppName (keys %{$combi_DeviceName_AppName{$DeviceName}}) {
					if ($ENV{opt_s} eq "") {
						'"$PRINT_LONG_HEADER"'
						foreach $ValidateState (keys %{$combi_DeviceName_AppName_ValidateState_count{$DeviceName}{$AppName}}) {
							printf "\t\t\t\t";
							'"$PRINT_LONG_FORMAT"'
						}
					} else {
						foreach $ValidateState (keys %{$combi_DeviceName_AppName_ValidateState_count{$DeviceName}{$AppName}}) {
							if ($ENV{opt_s} eq $ValidateState) {
								printf "%-16s %-6s %4d\t", $DeviceName, $AppName, $combi_DeviceName_AppName{$DeviceName}{$AppName};
								'"$PRINT_LONG_FORMAT"'
							}
						}
					}
				}
			}
		}
	}
' "$@"
}

wcgget() {
	[ -n "$opt_f" ] && Offset="&Offset=$skipm"
	wget $QUIET -O $TMPFILE "$URLBASE/api/members/$MEMBER/results?code=$VERIFY&format=json&ServerState=$ServerState$ValidateState$SortBy$Offset&Limit=$opt_l" && [ -s $TMPFILE ] &&
	calculate_or_record $TMPFILE
	if [ -n "$opt_f" ]; then
		mv $TMPFILE $TMPFILE.$skipm
		[ -s $TMPFILE.$skipm ] || exit 1
	fi
}

wcgget_cumulative() {
	SortBy="&SortBy=CpuTime" # CpuTime is rather unique for each WU, in order to prevent fetching duplicate WU-entries from the database (resulting from overlap in two or more fetches) using other key selections such as SentTime.
	# (https://www.worldcommunitygrid.org/help/viewTopic.do?shortName=api says "Default is SentTime.")
	wcgget
	let avail=`perl -wne 'print if s/\s+"ResultsAvailable": "([^"]+)",\s+/$1/' $TMPFILE.$skipm` #     "ResultsAvailable": "395",
	let toget=$avail-$opt_l
	while [ $toget -gt 0 ]; do let skipm=$skipm+$opt_l; wcgget; let toget=$toget-$opt_l; done
}

if [ $opt_d = 0 ]; then
	calculate_or_record "$@"
else
	let skipm=0 # offset
	if [ -n "$opt_f" ]
	then
		QUIET=-q
		wcgget_cumulative
	else
		QUIET=""
		wcgget
	fi
fi