pengyuthon/odoo_source
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[DEL] web: remove old tour system

Browse Source
This commit is contained in:
qsm-odoo
2016-09-02 18:09:07 +01:00
parent 689bf6185b
commit 5a1db6cde2
3 changed files with 0 additions and 747 deletions
Download Patch File Download Diff File Expand all files Collapse all files
addons/web/static/src/js/tour.js
-719
View File
@@ -1,719 +0,0 @@
odoo.define('web.Tour', function (require) {
"use strict";
var core = require('web.core');
var local_storage = require('web.local_storage');
var _t = core._t;
var qweb = core.qweb;
/////////////////////////////////////////////////
$.fn.getHandlers = function () {
var results = [];
var $elementsToWatch = $(this).add($(this).parents());
var $allElements = $("*").add(document);
var addEventHandlerInfo = function (element, event, $elementsCovered) {
var extendedEvent = event;
if ($elementsCovered !== void 0 && $elementsCovered !== null) {
$.extend(extendedEvent, { targets: $elementsCovered.toArray() });
}
var eventInfo;
var eventsInfo = $.grep(results, function (evInfo, index) {
return element === evInfo.element;
});
if (eventsInfo.length === 0) {
eventInfo = {
element: element
};
eventInfo[extendedEvent.type] = [extendedEvent];
results.push(eventInfo);
} else {
eventInfo = eventsInfo[0];
if (!eventInfo[extendedEvent.type]) {
eventInfo[extendedEvent.type] = [];
}
eventInfo[extendedEvent.type].push(extendedEvent);
}
};
var checkEventHandler = function (element, ElementEvents) {
$.each(ElementEvents, function(i, event){
var isDelegateEvent = event.selector !== void 0 && event.selector !== null;
var $elementsCovered;
if (isDelegateEvent) {
$elementsCovered = $(event.selector, element); //only look at children of the element, since those are the only ones the handler covers
} else {
$elementsCovered = $(element); //just itself
}
if (_.intersection($elementsCovered, $elementsToWatch).length) {
addEventHandlerInfo(element, event, $elementsCovered);
}
});
};
$.each($allElements, function (elementIndex, element) {
var allElementEvents = $._data(element, "events");
if (allElementEvents) {
_.each(allElementEvents, function (ElementEvents) {
checkEventHandler(element, ElementEvents);
});
}
});
return results;
};
/////////////////////////////////////////////////
var Tour = {
tours: {},
defaultDelay: 50,
autoRunning: true,
retryRunningDelay: 1000,
errorDelay: 10000,
state: null,
$element: null,
timer: null,
testtimer: null,
currentTimer: null,
register: function (tour) {
if (tour.mode !== "test") tour.mode = "tutorial";
Tour.tours[tour.id] = tour;
},
/*
* tour_id: string
* mode: test or tutorial
* log: null (alone log who display the html content)
* 'events' (add log for event handlers)
*/
run: function (tour_id, mode, log) {
var tour = Tour.tours[tour_id];
if (!tour) {
return Tour.error(null, "Can't run '"+tour_id+"' (tour undefined)");
}
Tour.log("Tour '"+tour_id+"' Begin from run method", true);
var state = Tour.getState();
if (state) {
if (state.mode === "test") {
return Tour.error(false, "An other running tour has been detected all tours are now killed.");
} else {
Tour.endTour();
}
}
this.time = new Date().getTime();
if (tour.path && !window.location.href.match(new RegExp("("+Tour.getLang()+")?"+tour.path+"#?$", "i"))) {
var href = Tour.getLang()+tour.path;
Tour.saveState(tour.id, mode || tour.mode, -1, 0, 0, log || null);
$(document).one("ajaxStop", Tour.running);
window.location.href = href;
} else {
Tour.saveState(tour.id, mode || tour.mode, 0, 0, 0, log || null);
Tour.running();
}
},
registerSteps: function (tour, mode) {
if (tour.register) {
return;
}
tour.register = true;
for (var index=0; index<tour.steps.length; index++) {
var step = tour.steps[index];
if (!step.waitNot && index > 0 && tour.steps[index-1] &&
tour.steps[index-1].popover && tour.steps[index-1].popover.next) {
step.waitNot = '.popover.tour.fade.in:visible';
}
if (!step.waitFor && index > 0 && tour.steps[index-1].snippet) {
step.waitFor = '.oe_overlay_options .oe_options:visible';
}
var snippet = step.element && step.element.match(/#oe_snippets (.*) \.oe_snippet_thumbnail/);
if (snippet) {
step.snippet = snippet[1];
} else if (step.snippet) {
step.element = '#oe_snippets ' + step.snippet + ' .oe_snippet_thumbnail';
}
step.id = index;
if (!step.element) {
step.element = "body";
step.orphan = true;
step.backdrop = true;
} else {
step.popover = step.popover || {};
step.popover.arrow = true;
}
}
if (tour.steps[index-1] &&
tour.steps[index-1].popover && tour.steps[index-1].popover.next) {
var step = {
_title: "close popover and finish",
id: index,
waitNot: '.popover.tour.fade.in:visible'
};
tour.steps.push(step);
}
// rendering bootstrap tour and popover
if (mode !== "test") {
for (var index=0, len=tour.steps.length; index<len; index++) {
var step = tour.steps[index];
step._title = step._title || step.title;
step.title = Tour.popoverTitle(tour, { title: step._title });
step.template = step.template || Tour.popover( step.popover );
}
}
},
closePopover: function () {
if (Tour.$element) {
Tour.$element.popover('destroy');
Tour.$element.removeData("tour");
Tour.$element.removeData("tour-step");
$(".tour-backdrop").remove();
if (Tour.$popover.data('bs.popover')) {
Tour.$popover.data('bs.popover').$element.popover('destroy');
}
Tour.$popover.remove();
Tour.$element = null;
}
},
autoTogglePopover: function () {
var state = Tour.getState();
var step = state.step;
if (Tour.$element &&
Tour.$element.is(":visible") &&
Tour.$element.data("tour") === state.id &&
Tour.$element.data("tour-step") === step.id) {
Tour.repositionPopover();
return;
}
if (step.busy) {
return;
}
Tour.closePopover();
var $element = $(step.element).first();
if (!step.element || !$element.size() || !$element.is(":visible")) {
return;
}
Tour.$element = $element;
Tour.scrollIntoView($element);
$element.data("tour", state.id);
$element.data("tour-step", step.id);
$element.popover({
selector: "xxx", // to fix 'data-original-title'
placement: step.placement || "auto",
animation: true,
trigger: "manual",
title: step.title,
content: step.content,
html: true,
container: "body",
template: step.template,
orphan: step.orphan
}).popover("show");
var $tip = $element.data("bs.popover").tip();
Tour.$popover = $tip.add($element.data("bs.popover").arrow());
// add popover style (orphan, static, backdrop)
if (step.orphan) {
$tip.addClass("orphan");
}
var node = $element[0];
var css;
do {
css = window.getComputedStyle(node);
if (!css || css.position == "fixed") {
$tip.addClass("fixed");
break;
}
} while ((node = node.parentNode) && node !== document);
if (step.backdrop) {
$("body").append('<div class="tour-backdrop"></div>');
}
if (step.backdrop || $element.parents("#web_editor-top-edit, .oe_navbar, .modal").size()) {
$tip.css("z-index", 2010);
}
// button click event
$tip.find("button")
.one("click", function () {
step.busy = true;
if (!$(this).is("[data-role='next']")) {
clearTimeout(Tour.timer);
Tour.endTour();
}
Tour.closePopover();
});
Tour.repositionPopover();
},
repositionPopover: function() {
var popover = Tour.$element.data("bs.popover");
var $tip = popover.tip();
if (popover.options.orphan) {
return $tip.css("top", $(window).outerHeight() / 2 - $tip.outerHeight() / 2);
}
if (Tour.$element.parents("div").filter(function(){ return getComputedStyle(this).position === 'fixed'; }).length) {
var pos = popover.getPosition();
var top = pos.top;
if (popover.options.placement === "top") top -= $tip.height();
if (popover.options.placement === "bottom") top += pos.height;
$tip.css({'top': top+'px'});
}
var offsetBottom, offsetHeight, offsetRight, offsetWidth, originalLeft, originalTop, tipOffset;
offsetWidth = $tip[0].offsetWidth;
offsetHeight = $tip[0].offsetHeight;
tipOffset = $tip.offset();
originalLeft = tipOffset.left;
originalTop = tipOffset.top;
offsetBottom = $(document).outerHeight() - tipOffset.top - $tip.outerHeight();
if (offsetBottom < 0) {
tipOffset.top = tipOffset.top + offsetBottom;
}
offsetRight = $("html").outerWidth() - tipOffset.left - $tip.outerWidth();
if (offsetRight < 0) {
tipOffset.left = tipOffset.left + offsetRight;
}
if (tipOffset.top < 0) {
tipOffset.top = 0;
}
if (tipOffset.left < 0) {
tipOffset.left = 0;
}
$tip.offset(tipOffset);
if (popover.options.placement === "bottom" || popover.options.placement === "top") {
var left = Tour.$element.offset().left + Tour.$element.outerWidth()/2 - tipOffset.left;
popover.arrow().css("left", left ? left + "px" : "");
} else if (popover.options.placement !== "auto") {
var top = Tour.$element.offset().top + Tour.$element.outerHeight()/2 - tipOffset.top;
popover.arrow().css("top", top ? top + "px" : "");
}
},
_load_template: false,
load_template: function () {
// don't need template to use bootstrap Tour in automatic mode
Tour._load_template = true;
if (typeof QWeb2 === "undefined") return $.when();
var def = $.Deferred();
qweb.add_template('/web/static/src/xml/website.tour.xml', function(err) {
if (err) {
def.reject(err);
} else {
def.resolve();
}
});
return def;
},
popoverTitle: function (tour, options) {
return typeof QWeb2 !== "undefined" ? qweb.render('tour.popover_title', options) : options.title;
},
popover: function (options) {
return typeof QWeb2 !== "undefined" ? qweb.render('tour.popover', options) : options.title;
},
getLang: function () {
return $("html").attr("lang") ? "/" + $("html").attr("lang").replace(/-/, '_') : "";
},
getState: function () {
var state = JSON.parse(local_storage.getItem("tour") || 'false') || {};
if (state) { this.time = state.time; }
var tour_id,mode,step_id;
if (!state.id && window.location.href.indexOf("#tutorial.") > -1) {
state = {
"id": window.location.href.match(/#tutorial\.(.*)=true/)[1],
"mode": "tutorial",
"step_id": 0
};
window.location.hash = "";
Tour.log("Tour '"+state.id+"' Begin from url hash");
Tour.saveState(state.id, state.mode, state.step_id, 0, state.log);
}
if (!state.id) {
return;
}
state.tour = Tour.tours[state.id];
state.step = state.tour && state.tour.steps[state.step_id === -1 ? 0 : state.step_id];
return state;
},
log: function (message, add_user) {
if (add_user) {
var user = $(".navbar .dropdown:has(>.js_usermenu) a:first, .navbar .oe_topbar_name, .pos .username").text();
if (!user && $('a[href*="/login"]')) user = 'Public User';
message += " (" + (user||"").replace(/^\s*|\s*$/g, '') + ")";
}
console.log(message);
},
logError: function (step, message, all) {
var state = Tour.getState();
message += '\ntour: ' + state.id
+ (step ? '\nstep: ' + step.id + ": '" + (step._title || step.title) + "'" : '' )
+ (all ? '\nhref: ' + window.location.href : '' )
+ (all ? '\nreferrer: ' + document.referrer : '' )
+ (step ? '\nelement: ' + ((!step.element || ($(step.element).size() && $(step.element).is(":visible") && !$(step.element).is(":hidden"))) ? 'true ' : 'false') : '' )
+ (step && step.element ? " "+JSON.stringify(step.element) : "")
+ (step ? '\nwaitNot: ' + ((!step.waitNot || !$(step.waitNot).size()) ? 'true ' : 'false') : '' )
+ (step && step.waitNot ? " "+JSON.stringify(step.waitNot) : "")
+ (step ? '\nwaitFor: ' + ((!step.waitFor || $(step.waitFor).size()) ? 'true ' : 'false') : '' )
+ (step && step.waitFor ? " "+JSON.stringify(step.waitFor) : "")
+ (all ? "\nlocalStorage: " + JSON.stringify(window.localStorage) : '' )
+ (all && !state.log ? '\n\n' + $("body").html() : '' );
Tour.log(message, true);
},
error: function (step, message) {
var state = Tour.getState();
Tour.logError(step, "error: " + message, true);
Tour.endTour();
},
lists: function () {
var tour_ids = [];
for (var k in Tour.tours) {
tour_ids.push(k);
}
return tour_ids;
},
saveState: function (tour_id, mode, step_id, number, wait, log) {
local_storage.setItem("tour", JSON.stringify({
"id":tour_id,
"mode":mode,
"step_id":step_id || 0,
"time": this.time,
"number": number+1,
"wait": wait || 0,
"log": log
}));
},
reset: function () {
var state = Tour.getState();
if (state && state.tour) {
for (var k in state.tour.steps) {
state.tour.steps[k].busy = false;
}
}
local_storage.removeItem("tour");
clearTimeout(Tour.timer);
clearTimeout(Tour.testtimer);
Tour.closePopover();
Tour.log("Tour reset");
},
running: function () {
var state = Tour.getState();
if (!state) return;
else if (state.tour) {
if (!Tour._load_template) {
Tour.load_template().then(Tour.running);
return;
}
Tour.log("Tour '"+state.id+"' is running", true);
Tour.registerSteps(state.tour, state.mode);
Tour.nextStep();
} else {
if (state.mode === "test" && state.wait >= 10) {
return Tour.error(state.step, "Tour '"+state.id+"' undefined");
}
Tour.saveState(state.id, state.mode, state.step_id, state.number-1, state.wait+1, state.log);
//Tour.log("Tour '"+state.id+"' wait for running (tour undefined)");
setTimeout(Tour.running, Tour.retryRunningDelay);
}
},
check: function (step) {
return (step &&
(!step.element || ($(step.element).size() && $(step.element).is(":visible") && !$(step.element).is(":hidden"))) &&
(!step.waitNot || !$(step.waitNot).size()) &&
(!step.waitFor || $(step.waitFor).size()));
},
waitNextStep: function () {
var state = Tour.getState();
var time = new Date().getTime();
var timer;
var next = state.step.next ? Tour.search_step(state.step.next) : state.tour.steps[state.step.id+1];
var overlaps = state.mode === "test" ? Tour.errorDelay : 0;
window.onbeforeunload = function () {
clearTimeout(Tour.timer);
clearTimeout(Tour.testtimer);
};
function checkNext () {
if (!Tour.getState()) return;
Tour.autoTogglePopover();
clearTimeout(Tour.timer);
if (Tour.check(next)) {
clearTimeout(Tour.currentTimer);
// use an other timeout for cke dom loading
Tour.saveState(state.id, state.mode, state.step.id, 0, 0, state.log);
setTimeout(function () {
if (state.step.onend) {
try {
if(Tour._goto(state.step.onend())) {
return;
}
} catch (e) {
console.log(e);
}
}
Tour.nextStep(next);
}, Tour.defaultDelay);
return;
} else if (!overlaps || new Date().getTime() - time < overlaps) {
Tour.timer = setTimeout(checkNext, Tour.defaultDelay);
return;
} else if(next.onerror) {
Tour.logError(next, "error: Can't reach the next step (call next step onerror)", false);
var id = next.onerror();
if (id) {
if (Tour._goto(id)) return;
if (id === true) {
Tour.nextStep(next);
return;
}
}
}
Tour.error(next, "Can't reach the next step");
return;
}
setTimeout(checkNext, 0);
},
search_step: function (id_or_title) {
var state = Tour.getState();
if (id_or_title !== undefined) {
if (isNaN(id_or_title)) {
for (var k=0; k<state.tour.steps.length; k++) {
if (state.tour.steps[k].title === id_or_title || state.tour.steps[k]._title === id_or_title) {
return state.tour.steps[k];
}
}
} else {
return state.tour.steps[id_or_title];
}
}
return undefined;
},
_goto: function (id_or_title) {
var state = Tour.getState();
if (!state) return true;
if (id_or_title === undefined) return false;
var step = Tour.search_step(id_or_title);
Tour.saveState(state.id, state.mode, step.id, 0, 0, state.log);
Tour.nextStep(Tour.getState().step);
return true;
},
nextStep: function (step) {
var state = Tour.getState();
if (!state) {
return;
}
step = step || state.step;
var next = state.step.next ? Tour.search_step(state.step.next) : state.tour.steps[step.id+1];
if (state.mode === "test" && state.number > 5) {
return Tour.error(next, "Cycling. Can't reach the next step");
}
Tour.saveState(state.id, state.mode, step.id, state.number, 0, state.log);
if (state.number === 1) {
Tour.log("Tour '"+state.id+"' Step: '" + (step._title || step.title) + "' (" + (new Date().getTime() - this.time) + "ms)");
}
Tour.autoTogglePopover(true);
// onload a step you can fallback to an other step
if (step.onload) {
try {
if(Tour._goto(step.onload())) {
return;
}
} catch (e) {
console.log(e);
}
}
if (state.mode === "test") {
setTimeout(function () {
if (Tour.check(step)) { // re-test because if click on a link to change page, don't want to click again after
Tour.autoNextStep(state.tour, step, state);
}
if (next && Tour.getState()) {
Tour.waitNextStep();
}
}, step.wait || Tour.defaultDelay);
} else if (next) {
setTimeout(Tour.waitNextStep, next.wait || 0);
}
if (!next) {
Tour.endTour();
}
},
endTour: function () {
var state = Tour.getState();
var test = state.step && state.step.id >= state.tour.steps.length-1;
Tour.reset();
if (test) {
Tour.log("Tour '"+state.id+"' finish: ok");
Tour.log('ok');
} else {
Tour.log("Tour '"+state.id+"' finish: error");
Tour.log('error');
}
},
autoNextStep: function (tour, step, state) {
clearTimeout(Tour.testtimer);
function autoStep () {
if (!Tour.getState()) return;
if (!step) return;
if (step.autoComplete) {
step.autoComplete(tour);
}
var $element = $(step.element);
if ((step.element === "body" && step.backdrop) || !$element.size()) return;
$(".popover.tour [data-role='next']").click();
if (state.log === "events") console.log("Event handlers:", $element[0], $element.getHandlers());
var click_event = function(type) {
var evt = document.createEvent("MouseEvents");
evt.initMouseEvent(type, true, true, window, 0, 0, 0, 0, 0, false, false, false, false, 0, $element[0]);
$element[0].dispatchEvent(evt);
};
if (step.snippet) {
Tour.autoDragAndDropSnippet($element);
} else if (step.keydown) {
if (!(step.keydown instanceof Array)) {
step.keydown = [step.keydown];
}
var keydown = function (list) {
var keyCode = list.shift();
if (keyCode) {
setTimeout(function () {
setTimeout(function () {
$element.trigger({ type: 'keydown', keyCode: keyCode });
if ((keyCode > 47 && keyCode < 58) || // number keys
keyCode == 32 || // spacebar
(keyCode > 64 && keyCode < 91) || // letter keys
(keyCode > 95 && keyCode < 112) || // numpad keys
(keyCode > 185 && keyCode < 193) || // ;=,-./` (in order)
(keyCode > 218 && keyCode < 223)) { // [\]' (in order))
document.execCommand('insertText', 0, String.fromCharCode(keyCode));
}
$element.trigger({ type: 'keyup', keyCode: keyCode });
keydown(list);
},0);
},25);
}
};
keydown(step.keydown.slice());
} else if ($element.is(":visible")) {
click_event("mouseover");
click_event("mousedown");
click_event("mouseup");
$element.trigger('mouseenter'); // click_event("mouseenter") doesn't work because jquery event handler register mouseenter as mouseover
click_event("click");
if ($element.is("input, textarea, select") && !$element.is(":focus")) {
$element.focus();
}
// trigger after for step like: mouseenter, next step click on button display with mouseenter
setTimeout(function () {
if (!Tour.getState()) return;
click_event("mouseout");
}, self.defaultDelay<<1);
}
if (step.sampleText) {
$element.trigger($.Event("keydown", { srcElement: $element[0] }));
if ($element.is("input") || $element.is('textarea')) {
$element.val(step.sampleText);
} if ($element.is("select")) {
$element.val(step.sampleText);
} else {
$element.text(step.sampleText);
}
setTimeout(function () {
if (!Tour.getState()) return;
$element.trigger($.Event("keyup", { srcElement: $element[0] }));
$element.trigger($.Event("change", { srcElement: $element[0] }));
}, self.defaultDelay<<1);
}
}
Tour.testtimer = setTimeout(autoStep, 0);
},
autoDragAndDropSnippet: function (selector) {
var $thumbnail = $(selector).first();
var thumbnailPosition = $thumbnail.position();
$thumbnail.trigger($.Event("mousedown", { which: 1, pageX: thumbnailPosition.left, pageY: thumbnailPosition.top }));
$thumbnail.trigger($.Event("mousemove", { which: 1, pageX: document.body.scrollWidth/2, pageY: document.body.scrollHeight/2 }));
var $dropZone = $(".oe_drop_zone").first();
var dropPosition = $dropZone.position();
$thumbnail.trigger($.Event("mouseup", { which: 1, pageX: dropPosition.left, pageY: dropPosition.top }));
},
scrollIntoView: function ($element){
// if element is not on window (screen) then it scroll down to get popup visible
if (!$element.is('body') && !$element.parents().filter(function () { return $(this).css("position") === "fixed";}).length){
var element_top = $element.offset().top;
var visible = ((element_top > $(window).scrollTop()) && (element_top < ($(window).scrollTop() + $(window).height())));
if (!visible) {
$("body, html").animate({scrollTop: $element.offset().top - $(window).height() / 2 }, 800);
}
}
}
};
/////////////////////////////////////////////////
$(document).ready(function () {
setTimeout(function () {
if (Tour.autoRunning) {
Tour.running();
}
}, 250);
});
return Tour;
});
addons/web/static/src/xml/website.tour.xml
-27
View File
@@ -1,27 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<templates id="template" xml:space="preserve">
<t t-name="tour.popover">
<div t-attf-class="#{ fixed ? 'popover tour fixed' : 'popover tour' }">
<div class="arrow" t-if="!next"></div>
<h3 class="popover-title"></h3>
<div class="popover-content"></div>
<t t-if="next or end">
<nav class="popover-navigation">
<t t-if="next">
<button class="btn btn-sm btn-default" data-role="next"><t t-esc="next"/></button>
</t>
<small t-if="next &amp;&amp; end">
<span class="text-muted"> or </span>
<button class="btn-link" data-role="end" style="float: none; padding: 0"><t t-esc="end"/></button>
</small>
<t t-if="end &amp;&amp; ! next">
<button class="btn btn-sm btn-default" data-role="end"><t t-esc="end"/></button>
</t>
</nav>
</t>
</div>
</t>
<t t-name="tour.popover_title">
<t t-esc="title"/><button title="End This Tutorial" type="button" class="close" data-role="end">×</button>
</t>
</templates>
addons/web/views/webclient_templates.xml
-1
View File
@@ -73,7 +73,6 @@
<script type="text/javascript" src="/web/static/src/js/services/core.js"></script>
<script type="text/javascript" src="/web/static/src/js/framework/dialog.js"></script>
<script type="text/javascript" src="/web/static/src/js/framework/local_storage.js"></script>
<script type="text/javascript" src="/web/static/src/js/tour.js"></script>
<script type="text/javascript" src="/web/static/lib/bootstrap-datetimepicker/src/js/bootstrap-datetimepicker.js"></script>
<script type="text/javascript" src="/web/static/lib/select2/select2.js"></script>