seikai
4/25/2013 - 6:36 AM
Google Realtime Api Tutorial + Eclipse Orion (original : https://developers.google.com/drive/realtime/realtime-quickstart)
Google Realtime Api Tutorial + Eclipse Orion (original : https://developers.google.com/drive/realtime/realtime-quickstart)
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>Google Drive Realtime quickstart</title>
<meta http-equiv="X-UA-Compatible" content="IE=9">
<!-- Load the Realtime libraries. -->
<script type="text/javascript"
src="https://apis.google.com/js/api.js"></script>
<!-- Load the utility library. -->
<script type="text/javascript"
src="realtime-client-utils.js"></script>
<link rel="stylesheet" type="text/css" href="https://eclipse.org/orion/editor/releases/3.0/built-editor.css"/>
<script src="https://eclipse.org/orion/editor/releases/3.0/built-editor.js"></script>
<style>
pre.orionEditor {
padding: 0px;
border: 1px solid lightgrey;
height: 500px;
}
</style>
</head>
<!-- Start Realtime when the body has loaded. -->
<body onLoad='startRealtime()'>
<h1>Drive Realtime API :: quickstart</h1>
<button id="authorizeButton" disabled>You must authorize</button>
<!-- Text areas that will be used as our collaborative controls. -->
<pre class="orionEditor" data-editor-lang="js"></pre>
<script>
/**
* This function is called the first time that the Realtime model is created
* for a file. This function should be used to initialize any values of the
* model. In this case, we just create the single string model that will be
* used to control our text box. The string has a starting value of 'Hello
* Realtime World!', and is named 'text'.
* @param model {gapi.drive.realtime.Model} the Realtime root model object.
*/
function initializeModel(model) {
var string = model.createString('Hello Realtime World!');
model.getRoot().set('text', string);
}
/**
* This function is called when the Realtime file has been loaded. It should
* be used to initialize any user interface components and event handlers
* depending on the Realtime model. In this case, create a text control binder
* and bind it to our string model that we created in initializeModel.
* @param doc {gapi.drive.realtime.Document} the Realtime document.
*/
function onFileLoaded(doc) {
require(["orion/editor/edit"], function(edit) {
var orionEditor = edit({className:"orionEditor"})[0];
var string = doc.getModel().getRoot().get('text');
var updateEditor = function(event){
var offset = orionEditor.getCaretOffset();
var lineIndex = orionEditor.getModel().getLineAtOffset(offset);
if(string.toString() != orionEditor.getText())
orionEditor.setText(string.toString());
orionEditor.onGotoLine(lineIndex, 0, 0);
};
string.addEventListener(gapi.drive.realtime.EventType.TEXT_INSERTED, updateEditor);
string.addEventListener(gapi.drive.realtime.EventType.TEXT_DELETED, updateEditor);
orionEditor.setText(string.toString());
orionEditor.getModel().addEventListener("Changed", function(event){
string.setText(orionEditor.getText());
}, false);
});
}
/**
* Options for the Realtime loader.
*/
var realtimeOptions = {
/**
* Client ID from the APIs Console.
*/
clientId:'hoge',
/**
* The ID of the button to click to authorize. Must be a DOM element ID.
*/
authButtonElementId:'authorizeButton',
/**
* Function to be called when a Realtime model is first created.
*/
initializeModel:initializeModel,
/**
* Autocreate files right after auth automatically.
*/
autoCreate:true,
/**
* Autocreate files right after auth automatically.
*/
defaultTitle:"New Realtime Quickstart File",
/**
* Function to be called every time a Realtime file is loaded.
*/
onFileLoaded:onFileLoaded
}
/**
* Start the Realtime loader with the options.
*/
function startRealtime() {
var realtimeLoader = new rtclient.RealtimeLoader(realtimeOptions);
realtimeLoader.start();
}
</script>
</body>
</html>/**
* Copyright 2013 Google Inc. All Rights Reserved.
*
* 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.
*/
"use strict";
/**
* @fileoverview Common utility functionality for Google Drive Realtime API,
* including authorization and file loading. This functionality should serve
* mostly as a well-documented example, though is usable in its own right.
*/
/**
* @namespace Realtime client utilities namespace.
*/
var rtclient = rtclient || {}
/**
* OAuth 2.0 scope for installing Drive Apps.
* @const
*/
rtclient.INSTALL_SCOPE = 'https://www.googleapis.com/auth/drive.install'
/**
* OAuth 2.0 scope for opening and creating files.
* @const
*/
rtclient.FILE_SCOPE = 'https://www.googleapis.com/auth/drive.file'
/**
* OAuth 2.0 scope for accessing the user's ID.
* @const
*/
rtclient.OPENID_SCOPE = 'openid'
/**
* MIME type for newly created Realtime files.
* @const
*/
rtclient.REALTIME_MIMETYPE = 'application/vnd.google-apps.drive-sdk';
/**
* Parses the query parameters to this page and returns them as an object.
* @function
*/
rtclient.getParams = function() {
var params = {};
var queryString = window.location.search;
if (queryString) {
// split up the query string and store in an object
var paramStrs = queryString.slice(1).split("&");
for (var i = 0; i < paramStrs.length; i++) {
var paramStr = paramStrs[i].split("=");
params[paramStr[0]] = unescape(paramStr[1]);
}
}
console.log(params);
return params;
}
/**
* Instance of the query parameters.
*/
rtclient.params = rtclient.getParams();
/**
* Fetches an option from options or a default value, logging an error if
* neither is available.
* @param options {Object} containing options.
* @param key {string} option key.
* @param defaultValue {Object} default option value (optional).
*/
rtclient.getOption = function(options, key, defaultValue) {
var value = options[key] == undefined ? defaultValue : options[key];
if (value == undefined) {
console.error(key + ' should be present in the options.');
}
console.log(value);
return value;
}
/**
* Creates a new Authorizer from the options.
* @constructor
* @param options {Object} for authorizer. Two keys are required as mandatory, these are:
*
* 1. "clientId", the Client ID from the APIs Console
*/
rtclient.Authorizer = function(options) {
this.clientId = rtclient.getOption(options, 'clientId');
// Get the user ID if it's available in the state query parameter.
this.userId = rtclient.params['userId'];
this.authButton = document.getElementById(rtclient.getOption(options, 'authButtonElementId'));
}
/**
* Start the authorization process.
* @param onAuthComplete {Function} to call once authorization has completed.
*/
rtclient.Authorizer.prototype.start = function(onAuthComplete) {
var _this = this;
gapi.load('auth:client,drive-realtime,drive-share', function() {
_this.authorize(onAuthComplete);
});
}
/**
* Reauthorize the client with no callback (used for authorization failure).
* @param onAuthComplete {Function} to call once authorization has completed.
*/
rtclient.Authorizer.prototype.authorize = function(onAuthComplete) {
var clientId = this.clientId;
var userId = this.userId;
var _this = this;
var handleAuthResult = function(authResult) {
if (authResult && !authResult.error) {
_this.authButton.disabled = true;
_this.fetchUserId(onAuthComplete);
} else {
_this.authButton.disabled = false;
_this.authButton.onclick = authorizeWithPopup;
}
};
var authorizeWithPopup = function() {
gapi.auth.authorize({
client_id: clientId,
scope: [
rtclient.INSTALL_SCOPE,
rtclient.FILE_SCOPE,
rtclient.OPENID_SCOPE
],
user_id: userId,
immediate: false
}, handleAuthResult);
console.log(clientId);
};
// Try with no popups first.
gapi.auth.authorize({
client_id: clientId,
scope: [
rtclient.INSTALL_SCOPE,
rtclient.FILE_SCOPE,
rtclient.OPENID_SCOPE
],
user_id: userId,
immediate: true
}, handleAuthResult);
}
/**
* Fetch the user ID using the UserInfo API and save it locally.
* @param callback {Function} the callback to call after user ID has been
* fetched.
*/
rtclient.Authorizer.prototype.fetchUserId = function(callback) {
var _this = this;
gapi.client.load('oauth2', 'v2', function() {
gapi.client.oauth2.userinfo.get().execute(function(resp) {
if (resp.id) {
_this.userId = resp.id;
}
if (callback) {
callback();
}
});
});
};
/**
* Creates a new Realtime file.
* @param title {string} title of the newly created file.
* @param callback {Function} the callback to call after creation.
*/
rtclient.createRealtimeFile = function(title, callback) {
gapi.client.load('drive', 'v2', function() {
gapi.client.drive.files.insert({
'resource': {
mimeType: rtclient.REALTIME_MIMETYPE,
title: title
}
}).execute(callback);
});
}
/**
* Fetches the metadata for a Realtime file.
* @param fileId {string} the file to load metadata for.
* @param callback {Function} the callback to be called on completion, with signature:
*
* function onGetFileMetadata(file) {}
*
* where the file parameter is a Google Drive API file resource instance.
*/
rtclient.getFileMetadata = function(fileId, callback) {
gapi.client.load('drive', 'v2', function() {
gapi.client.drive.files.get({
'fileId' : id
}).execute(callback);
});
}
/**
* Parses the state parameter passed from the Drive user interface after Open
* With operations.
* @param stateParam {Object} the state query parameter as an object or null if
* parsing failed.
*/
rtclient.parseState = function(stateParam) {
try {
var stateObj = JSON.parse(stateParam);
return stateObj;
} catch(e) {
return null;
}
}
/**
* Redirects the browser back to the current page with an appropriate file ID.
* @param fileId {string} the file ID to redirect to.
* @param userId {string} the user ID to redirect to.
*/
rtclient.redirectTo = function(fileId, userId) {
var params = [];
if (fileId) {
params.push('fileId=' + fileId);
}
if (userId) {
params.push('userId=' + userId);
}
// Naive URL construction.
window.location.href = params.length == 0 ? '/' : ('?' + params.join('&'));
}
/**
* Handles authorizing, parsing query parameters, loading and creating Realtime
* documents.
* @constructor
* @param options {Object} options for loader. Four keys are required as mandatory, these are:
*
* 1. "clientId", the Client ID from the APIs Console
* 2. "initializeModel", the callback to call when the file is loaded.
* 3. "onFileLoaded", the callback to call when the model is first created.
*
* and one key is optional:
*
* 1. "defaultTitle", the title of newly created Realtime files.
*/
rtclient.RealtimeLoader = function(options) {
// Initialize configuration variables.
this.onFileLoaded = rtclient.getOption(options, 'onFileLoaded');
this.initializeModel = rtclient.getOption(options, 'initializeModel');
this.registerTypes = rtclient.getOption(options, 'registerTypes', function(){})
this.autoCreate = rtclient.getOption(options, 'autoCreate', false); // This tells us if need to we automatically create a file after auth.
this.defaultTitle = rtclient.getOption(options, 'defaultTitle', 'New Realtime File');
this.authorizer = new rtclient.Authorizer(options);
}
/**
* Starts the loader by authorizing.
* @param callback {Function} afterAuth callback called after authorization.
*/
rtclient.RealtimeLoader.prototype.start = function(afterAuth) {
// Bind to local context to make them suitable for callbacks.
var _this = this;
this.authorizer.start(function() {
if (_this.registerTypes) {
_this.registerTypes();
}
if (afterAuth) {
afterAuth();
}
_this.load();
});
}
/**
* Loads or creates a Realtime file depending on the fileId and state query
* parameters.
*/
rtclient.RealtimeLoader.prototype.load = function() {
var fileId = rtclient.params['fileId'];
var userId = this.authorizer.userId;
var state = rtclient.params['state'];
// Creating the error callback.
var authorizer = this.authorizer;
var handleErrors = function(e) {
if(e.type == gapi.drive.realtime.ErrorType.TOKEN_REFRESH_REQUIRED) {
authorizer.authorize();
} else if(e.type == gapi.drive.realtime.ErrorType.CLIENT_ERROR) {
alert("An Error happened: " + e.message);
window.location.href= "/";
} else if(e.type == gapi.drive.realtime.ErrorType.NOT_FOUND) {
alert("The file was not found. It does not exist or you do not have read access to the file.");
window.location.href= "/";
}
};
// We have a file ID in the query parameters, so we will use it to load a file.
if (fileId) {
gapi.drive.realtime.load(fileId, this.onFileLoaded, this.initializeModel, handleErrors);
return;
}
// We have a state parameter being redirected from the Drive UI. We will parse
// it and redirect to the fileId contained.
else if (state) {
var stateObj = rtclient.parseState(state);
// If opening a file from Drive.
if (stateObj.action == "open") {
fileId = stateObj.ids[0];
userId = stateObj.userId;
rtclient.redirectTo(fileId, userId);
return;
}
}
if (this.autoCreate) {
this.createNewFileAndRedirect();
}
}
/**
* Creates a new file and redirects to the URL to load it.
*/
rtclient.RealtimeLoader.prototype.createNewFileAndRedirect = function() {
//No fileId or state have been passed. We create a new Realtime file and
// redirect to it.
var _this = this;
rtclient.createRealtimeFile(this.defaultTitle, function(file) {
if (file.id) {
rtclient.redirectTo(file.id, _this.authorizer.userId);
}
// File failed to be created, log why and do not attempt to redirect.
else {
console.error('Error creating file.');
console.error(file);
}
});
}