Skip to content

Commit

Permalink
JS tool to do an ondemand update check
Browse files Browse the repository at this point in the history 
This file is provided as a code sample to show how to script an ondemand update check using JS.
  • Loading branch information
@sorinj
sorinj committed Apr 1, 2016
1 parent d1b5ff8 commit 10129cd
Showing 1 changed file with 399 additions and 0 deletions.
399 changes: 399 additions & 0 deletions omaha/tools/performondemand/update3web_demo.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,399 @@
// Copyright 2010 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ========================================================================

// Operations.
var CHECK_FOR_UPDATE = 0;
var DOWNLOAD = 1;
var INSTALL = 2;
var UPDATE = 3;
var LAUNCH_COMMAND = 4;

// The following states need to be kept in sync with the CurrentState enum in
// omaha3_idl.idl.
var STATE_INIT = 1;
var STATE_WAITING_TO_CHECK_FOR_UPDATE = STATE_INIT + 1;
var STATE_CHECKING_FOR_UPDATE = STATE_WAITING_TO_CHECK_FOR_UPDATE + 1;
var STATE_UPDATE_AVAILABLE = STATE_CHECKING_FOR_UPDATE + 1;
var STATE_WAITING_TO_DOWNLOAD = STATE_UPDATE_AVAILABLE + 1;
var STATE_RETRYING_DOWNLOAD = STATE_WAITING_TO_DOWNLOAD + 1;
var STATE_DOWNLOADING = STATE_RETRYING_DOWNLOAD + 1;
var STATE_DOWNLOAD_COMPLETE = STATE_DOWNLOADING + 1;
var STATE_EXTRACTING = STATE_DOWNLOAD_COMPLETE + 1;
var STATE_APPLYING_DIFFERENTIAL_PATCH = STATE_EXTRACTING + 1;
var STATE_READY_TO_INSTALL = STATE_APPLYING_DIFFERENTIAL_PATCH + 1;
var STATE_WAITING_TO_INSTALL = STATE_READY_TO_INSTALL + 1;
var STATE_INSTALLING = STATE_WAITING_TO_INSTALL + 1;
var STATE_INSTALL_COMPLETE = STATE_INSTALLING + 1;
var STATE_PAUSED = STATE_INSTALL_COMPLETE + 1;
var STATE_NO_UPDATE = STATE_PAUSED + 1;
var STATE_ERROR = STATE_NO_UPDATE + 1;

// The following states need to be kept in sync with the AppCommandStatus enum
// in omaha3_idl.idl.
var COMMAND_STATUS_INIT = 1;
var COMMAND_STATUS_RUNNING = COMMAND_STATUS_INIT + 1;
var COMMAND_STATUS_ERROR = COMMAND_STATUS_RUNNING + 1;
var COMMAND_STATUS_COMPLETE = COMMAND_STATUS_ERROR + 1;

function update3webProgId(is_machine) {
return 'GoogleUpdate.Update3Web' + (is_machine ? 'Machine' : 'User');
}

function initializeBundle(is_machine) {
var update3web = WScript.CreateObject(update3webProgId(is_machine));
var bundle = update3web.createAppBundleWeb();
bundle.initialize();
return bundle;
}

function initializeBundleForInstall(is_machine) {
return initializeBundle(is_machine);
}

function doCheckForUpdate(appId, is_machine) {
var bundle = initializeBundle(is_machine);

bundle.createInstalledApp(appId);
bundle.checkForUpdate();
doLoopUntilDone(CHECK_FOR_UPDATE, bundle);
}

function doDownload(appId, is_machine) {
var bundle = initializeBundle(is_machine);

bundle.createApp(appId, 'GPEZ', 'en', '');
bundle.checkForUpdate();
doLoopUntilDone(DOWNLOAD, bundle);
}

function doInstall(appId, is_machine) {
var bundle = initializeBundleForInstall(is_machine);

bundle.createApp(appId, 'GPEZ', 'en', '');
bundle.checkForUpdate();
doLoopUntilDone(INSTALL, bundle);
}

function doUpdate(appId, is_machine) {
var bundle = initializeBundleForInstall(is_machine);

bundle.createInstalledApp(appId);
bundle.checkForUpdate();
doLoopUntilDone(UPDATE, bundle);
}

function doLaunchCommand(appId, is_machine, command, argument_list) {
var bundle = initializeBundle(is_machine);
bundle.createInstalledApp(appId);

var app = bundle.appWeb(0);
if (!app) {
WScript.Echo('App not found.');
return;
}

var cmd = app.command(command);
if (!cmd) {
WScript.Echo('Command not found.');
return;
}

try {
WScript.Echo('Launching command.');

switch (argument_list.length) {
case 0:
cmd.execute();
break;
case 1:
cmd.execute(argument_list[0]);
break;
case 2:
cmd.execute(argument_list[0], argument_list[1]);
break;
case 3:
cmd.execute(argument_list[0], argument_list[1], argument_list[2]);
break;
case 4:
cmd.execute(argument_list[0],
argument_list[1],
argument_list[2],
argument_list[3]);
break;
case 5:
cmd.execute(argument_list[0],
argument_list[1],
argument_list[2],
argument_list[3],
argument_list[4]);
case 6:
cmd.execute(argument_list[0],
argument_list[1],
argument_list[2],
argument_list[3],
argument_list[4],
argument_list[5]);
case 7:
cmd.execute(argument_list[0],
argument_list[1],
argument_list[2],
argument_list[3],
argument_list[4],
argument_list[5],
argument_list[6]);
case 8:
cmd.execute(argument_list[0],
argument_list[1],
argument_list[2],
argument_list[3],
argument_list[4],
argument_list[5],
argument_list[6],
argument_list[7]);
case 9:
cmd.execute(argument_list[0],
argument_list[1],
argument_list[2],
argument_list[3],
argument_list[4],
argument_list[5],
argument_list[6],
argument_list[7],
argument_list[8]);
break;
default: WScript.Echo('Too many arguments.'); return;
}
WScript.Echo('Command launched.');
} catch (ex) {
WScript.Echo('Error: ' + ex.description + ': ' + ex.number);
return;
}

while (true) {
var status = cmd.status;
var stateDescription = '';

switch (status) {
case COMMAND_STATUS_RUNNING:
stateDescription = 'Running...';
break;

case COMMAND_STATUS_ERROR:
stateDescription = 'Error!';
break;

case COMMAND_STATUS_COMPLETE:
stateDescription = 'Exited with code ' + cmd.exitCode + '.';
break;

default:
stateDescription = 'Unhandled state!';
break;
}
WScript.Echo('[State][' + status + '][' + stateDescription + ']');

if (status != COMMAND_STATUS_RUNNING) {
return;
}
WScript.Sleep(100);
}
}

function doLoopUntilDone(operation, bundle) {
function operationDone() {
if (!bundle) {
WScript.Echo('No bundle is defined!');
return false;
}

var done = false;
var app = bundle.appWeb(0);
var state = app.currentState;
var stateDescription = '';
var extraData = '';

switch (state.stateValue) {
case STATE_INIT:
stateDescription = 'Initializating...';
break;

case STATE_WAITING_TO_CHECK_FOR_UPDATE:
case STATE_CHECKING_FOR_UPDATE:
stateDescription = 'Checking for update...';
extraData = '[Current Version][' + app.currentVersionWeb.version + ']';
break;

case STATE_UPDATE_AVAILABLE:
stateDescription = 'Update available!';
extraData = '[Next Version][' + app.nextVersionWeb.version + ']';
if (operation == CHECK_FOR_UPDATE) {
done = true;
break;
}

bundle.download();
break;

case STATE_WAITING_TO_DOWNLOAD:
case STATE_RETRYING_DOWNLOAD:
stateDescription = 'Contacting server...';
break;

case STATE_DOWNLOADING:
stateDescription = 'Downloading...';
extraData = '[Bytes downloaded][' + state.bytesDownloaded + ']' +
'[Bytes total][' + state.totalBytesToDownload + ']' +
'[Time remaining][' + state.downloadTimeRemainingMs + ']';
break;

case STATE_DOWNLOAD_COMPLETE:
case STATE_EXTRACTING:
case STATE_APPLYING_DIFFERENTIAL_PATCH:
case STATE_READY_TO_INSTALL:
stateDescription = 'Download completed!';
extraData = '[Bytes downloaded][' + state.bytesDownloaded + ']' +
'[Bytes total][' + state.totalBytesToDownload + ']';
if (operation == DOWNLOAD) {
done = true;
break;
}

bundle.install();
break;

case STATE_WAITING_TO_INSTALL:
case STATE_INSTALLING:
stateDescription = 'Installing...';
extraData = '[Install Progress][' + state.installProgress + ']' +
'[Time remaining][' + state.installTimeRemainingMs + ']';
break;

case STATE_INSTALL_COMPLETE:
stateDescription = 'Done!';
done = true;
break;

case STATE_PAUSED:
stateDescription = 'Paused...';
break;

case STATE_NO_UPDATE:
stateDescription = 'No update available!';
done = true;
break;

case STATE_ERROR:
stateDescription = 'Error!';
extraData = '[errorCode][' + state.errorCode + ']' +
'[completionMessage][' + state.completionMessage + ']' +
'[installerResultCode][' + state.installerResultCode + ']';
done = true;
break;

default:
stateDescription = 'Unhandled state...';
break;
}

WScript.Echo('[State][' + state.stateValue + '][' + stateDescription + ']');
if (extraData.length > 0) {
WScript.Echo('[Data][' + extraData + ']');
}

return done;
}

while (!operationDone()) {
WScript.Sleep(100);
}
}

////////////////////////////////////////////////////////////////////////////////
// Main
////////////////////////////////////////////////////////////////////////////////

function parseAndRun() {
if (WScript.Arguments.length < 3) {
return false;
}

var app_guid = WScript.Arguments(0);
var is_machine = Boolean(parseInt(WScript.Arguments(1)));
var operation = parseInt(WScript.Arguments(2));

switch (operation) {
case CHECK_FOR_UPDATE:
if (WScript.Arguments.length != 3) {
return false;
}
doCheckForUpdate(app_guid, is_machine);
break;

case DOWNLOAD:
if (WScript.Arguments.length != 3) {
return false;
}
doDownload(app_guid, is_machine);
break;

case INSTALL:
if (WScript.Arguments.length != 3) {
return false;
}
doInstall(app_guid, is_machine);
break;

case UPDATE:
if (WScript.Arguments.length != 3) {
return false;
}
doUpdate(app_guid, is_machine);
break;

case LAUNCH_COMMAND:
if (WScript.Arguments.length < 4) {
return false;
}
var command = WScript.Arguments(3);
var argument_list = [];
for (var i = 4; i < WScript.Arguments.length; ++i) {
argument_list.push(WScript.Arguments(i));
}
doLaunchCommand(app_guid, is_machine, command, argument_list);
break;

default:
return false;
}

return true;
}

try {
if (!parseAndRun()) {
WScript.Echo(
'Usage: {GUID} ' +
'{is_machine: 0|1} ' +
'{0|1|2|3|4==CheckForUpdate|Download|Install|Update|LaunchCommand} ' +
'{command_id?}');
}
} catch (ex) {
if (ex.number == -2147024703) {
WScript.Echo('ERROR_BAD_EXE_FORMAT: Try the SysWOW64 Script Host: ' +
ex.description);
} else {
WScript.Echo('Error: ' + ex.description + ': ' + ex.number);
}
}

0 comments on commit 10129cd

Please sign in to comment.