Skip to content

Fixed international composition issues (e.g., Japanese Input method) #999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JohnMcLear merged 2 commits into from
Sep 14, 2012
Merged

Fixed international composition issues (e.g., Japanese Input method) #999

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71c9444
fix for InternationalComposition(e.g., Japanese Input)
nagoya-y Sep 13, 2012
22315cd
Merge pull request #2 from ayokura/fix-international-composition
Sep 14, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 5 additions & 15 deletions src/static/js/ace2_inner.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1161,7 +1161,7 @@ function Ace2Inner(){
//if (! top.BEFORE) top.BEFORE = [];
//top.BEFORE.push(magicdom.root.dom.innerHTML);
//if (! isEditable) return; // and don't reschedule
if (inInternationalComposition)
if (window.parent.parent.inInternationalComposition)
{
// don't do idle input incorporation during international input composition
idleWorkTimer.atLeast(500);
Expand Down Expand Up @@ -1486,7 +1486,6 @@ function Ace2Inner(){

if (currentCallStack.domClean) return false;

inInternationalComposition = false; // if we need the document normalized, so be it
currentCallStack.isUserChange = true;

isTimeUp = (isTimeUp ||
Expand Down Expand Up @@ -3690,7 +3689,7 @@ function Ace2Inner(){
thisKeyDoesntTriggerNormalize = true;
}

if ((!specialHandled) && (!thisKeyDoesntTriggerNormalize) && (!inInternationalComposition))
if ((!specialHandled) && (!thisKeyDoesntTriggerNormalize) && (!window.parent.parent.inInternationalComposition))
{
if (type != "keyup" || !incorpIfQuick())
{
Expand Down Expand Up @@ -4550,19 +4549,9 @@ function Ace2Inner(){
}
}

var inInternationalComposition = false;

function handleCompositionEvent(evt)
{
// international input events, fired in FF3, at least; allow e.g. Japanese input
if (evt.type == "compositionstart")
{
inInternationalComposition = true;
}
else if (evt.type == "compositionend")
{
inInternationalComposition = false;
}
window.parent.parent.handleCompositionEvent(evt);
}

function bindTheEventHandlers()
Expand All @@ -4577,7 +4566,8 @@ function Ace2Inner(){
$(document).on("click", handleIEOuterClick);
}
if (browser.msie) $(root).on("paste", handleIEPaste);
if ((!browser.msie) && document.documentElement)
// CompositionEvent is not implemented below IE version 8
if ( !(browser.msie && browser.version < 9) && document.documentElement)
Copy link
Copy Markdown
Contributor

@Pita Pita Oct 11, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do feature detection instead of hard version checking if possible

Copy link
Copy Markdown
Contributor Author

@lepidum lepidum Oct 11, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're try to fix. but to separate from #1032.

{
$(document.documentElement).on("compositionstart", handleCompositionEvent);
$(document.documentElement).on("compositionend", handleCompositionEvent);
Expand Down
64 changes: 62 additions & 2 deletions src/static/js/collab_client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ function getCollabClient(ace2editor, serverVars, initialUserInfo, options, _pad)
var caughtErrorCatchers = [];
var caughtErrorTimes = [];
var debugMessages = [];
var msgQueue = [];
Copy link
Copy Markdown
Contributor

@Pita Pita Oct 11, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All this msgqueue stuff make me really worry. Why is this necessary?

Copy link
Copy Markdown
Contributor

@fourplusone fourplusone Oct 11, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think its used to avoid that changesets from the server are being applyed while the editor is in "internalCompositionState"

Copy link
Copy Markdown
Contributor Author

@lepidum lepidum Oct 11, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think its used to avoid that changesets from the server are being applyed while the editor is in "internalCompositionState"

That's correct.

@fourplusone Thank you!


tellAceAboutHistoricalAuthors(serverVars.historicalAuthorData);
tellAceActiveAuthorInfo(initialUserInfo);
Expand Down Expand Up @@ -110,6 +111,7 @@ function getCollabClient(ace2editor, serverVars, initialUserInfo, options, _pad)

function handleUserChanges()
{
if (window.parent.parent.inInternationalComposition) return;
if ((!getSocket()) || channelState == "CONNECTING")
{
if (channelState == "CONNECTING" && (((+new Date()) - initialStartConnectTime) > 20000))
Expand All @@ -128,12 +130,12 @@ function getCollabClient(ace2editor, serverVars, initialUserInfo, options, _pad)

if (state != "IDLE")
{
if (state == "COMMITTING" && (t - lastCommitTime) > 20000)
if (state == "COMMITTING" && msgQueue.length == 0 && (t - lastCommitTime) > 20000)
{
// a commit is taking too long
setChannelState("DISCONNECTED", "slowcommit");
}
else if (state == "COMMITTING" && (t - lastCommitTime) > 5000)
else if (state == "COMMITTING" && msgQueue.length == 0 && (t - lastCommitTime) > 5000)
{
callbacks.onConnectionTrouble("SLOW");
}
Expand All @@ -152,6 +154,36 @@ function getCollabClient(ace2editor, serverVars, initialUserInfo, options, _pad)
return;
}

// apply msgQueue changeset.
if (msgQueue.length != 0) {
while (msg = msgQueue.shift()) {
var newRev = msg.newRev;
rev=newRev;
if (msg.type == "ACCEPT_COMMIT")
{
editor.applyPreparedChangesetToBase();
setStateIdle();
callCatchingErrors("onInternalAction", function()
{
callbacks.onInternalAction("commitAcceptedByServer");
});
callCatchingErrors("onConnectionTrouble", function()
{
callbacks.onConnectionTrouble("OK");
});
handleUserChanges();
}
else if (msg.type == "NEW_CHANGES")
{
var changeset = msg.changeset;
var author = (msg.author || '');
var apool = msg.apool;

editor.applyChangesToBase(changeset, author, apool);
}
}
}

var sentMessage = false;
var userChangesData = editor.prepareUserChangeset();
if (userChangesData.changeset)
Expand Down Expand Up @@ -254,6 +286,22 @@ function getCollabClient(ace2editor, serverVars, initialUserInfo, options, _pad)
var changeset = msg.changeset;
var author = (msg.author || '');
var apool = msg.apool;

// When inInternationalComposition, msg pushed msgQueue.
if (msgQueue.length > 0 || window.parent.parent.inInternationalComposition) {
if (msgQueue.length > 0) oldRev = msgQueue[msgQueue.length - 1].newRev;
else oldRev = rev;

if (newRev != (oldRev + 1))
{
dmesg("bad message revision on NEW_CHANGES: " + newRev + " not " + (oldRev + 1));
setChannelState("DISCONNECTED", "badmessage_newchanges");
return;
}
msgQueue.push(msg);
return;
}

if (newRev != (rev + 1))
{
dmesg("bad message revision on NEW_CHANGES: " + newRev + " not " + (rev + 1));
Expand All @@ -266,6 +314,18 @@ function getCollabClient(ace2editor, serverVars, initialUserInfo, options, _pad)
else if (msg.type == "ACCEPT_COMMIT")
{
var newRev = msg.newRev;
if (msgQueue.length > 0)
{
if (newRev != (msgQueue[msgQueue.length - 1].newRev + 1))
{
dmesg("bad message revision on ACCEPT_COMMIT: " + newRev + " not " + (msgQueue[msgQueue.length - 1][0] + 1));
setChannelState("DISCONNECTED", "badmessage_acceptcommit");
return;
}
msgQueue.push(msg);
return;
}

if (newRev != (rev + 1))
{
dmesg("bad message revision on ACCEPT_COMMIT: " + newRev + " not " + (rev + 1));
Expand Down
16 changes: 16 additions & 0 deletions src/static/js/pad.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,22 @@ var randomString = require('./pad_utils').randomString;

var hooks = require('./pluginfw/hooks');

window.inInternationalComposition = false;
Copy link
Copy Markdown
Contributor

@Pita Pita Oct 11, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why does this have to be a global?

Copy link
Copy Markdown
Contributor Author

@lepidum lepidum Oct 11, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no special reason. We're trying to fix.

Copy link
Copy Markdown
Contributor Author

@lepidum lepidum Oct 11, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed by https://github.com/Pita/etherpad-lite/pull/1059

var inInternationalComposition = window.inInternationalComposition;

window.handleCompositionEvent = function handleCompositionEvent(evt)
{
// international input events, fired in FF3, at least; allow e.g. Japanese input
if (evt.type == "compositionstart")
{
this.inInternationalComposition = true;
}
else if (evt.type == "compositionend")
{
this.inInternationalComposition = false;
}
}

function createCookie(name, value, days, path)
{
if (days)
Expand Down