1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368 |
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
83×
83×
1×
28×
28×
28×
1×
27×
23×
7×
6×
7×
27×
1×
1×
4×
2×
27×
1×
26×
26×
26×
1×
1×
1×
26×
26×
25×
25×
23×
25×
1×
1×
25×
25×
1×
1×
40×
40×
40×
40×
40×
40×
40×
40×
40×
29×
11×
40×
1×
29×
29×
29×
29×
29×
1×
2×
1×
1×
1×
4×
1×
3×
3×
3×
1×
1×
19×
19×
1×
8×
8×
1×
2×
2×
1×
1×
1×
2×
1×
33×
33×
33×
9×
9×
33×
1×
9×
9×
9×
9×
9×
1×
3×
3×
1×
9×
9×
9×
4×
2×
2×
4×
4×
9×
1×
4×
4×
2×
2×
1×
1×
1×
34×
34×
34×
34×
34×
34×
34×
1×
34×
34×
34×
34×
34×
3×
34×
2×
1×
1×
1×
1×
1×
1×
34×
1×
18×
1×
52×
52×
1×
21×
21×
1×
34×
34×
34×
34×
34×
36×
9×
9×
27×
8×
1×
9×
8×
1×
7×
7×
7×
7×
7×
1×
5×
1×
4×
4×
4×
4×
3×
9×
9×
1×
7×
1× | 'use strict';
/**
* Inner helper class that deals with the logic of the individual steps needed to setup an ad in the player.
*
* @param player {object} instance of the player that will play the ad. It assumes that the videojs-contrib-ads plugin
* has been initialized when you use its utility functions.
*
* @constructor
*/
var VASTResponse = require('./VASTResponse');
var VASTError = require('./VASTError');
var VASTTracker = require('./VASTTracker');
var vastUtil = require('./vastUtil');
var async = require('../../utils/async');
var dom = require('../../utils/dom');
var playerUtils = require('../../utils/playerUtils');
var utilities = require('../../utils/utilityFunctions');
var logger = require ('../../utils/consoleLogger');
function VASTIntegrator(player) {
Iif (!(this instanceof VASTIntegrator)) {
return new VASTIntegrator(player);
}
this.player = player;
}
VASTIntegrator.prototype.playAd = function playAd(vastResponse, callback) {
var that = this;
callback = callback || utilities.noop;
if (!(vastResponse instanceof VASTResponse)) {
return callback(new VASTError('On VASTIntegrator, missing required VASTResponse'));
}
async.waterfall([
function (next) {
next(null, vastResponse);
},
this._selectAdSource.bind(this),
this._createVASTTracker.bind(this),
this._addClickThrough.bind(this),
this._addSkipButton.bind(this),
this._setupEvents.bind(this),
this._playSelectedAd.bind(this)
], function (error, response) {
if (error && response) {
that._trackError(error, response);
}
callback(error, response);
});
this._adUnit = {
_src: null,
type: 'VAST',
pauseAd: function () {
that.player.pause(true);
},
resumeAd: function () {
that.player.play(true);
},
isPaused: function () {
return that.player.paused(true);
},
getSrc: function () {
return this._src;
}
};
return this._adUnit;
};
VASTIntegrator.prototype._selectAdSource = function selectAdSource(response, callback) {
var source;
var playerWidth = dom.getDimension(this.player.el()).width;
response.mediaFiles.sort(function compareTo(a, b) {
var deltaA = Math.abs(playerWidth - a.width);
var deltaB = Math.abs(playerWidth - b.width);
return deltaA - deltaB;
});
source = this.player.selectSource(response.mediaFiles).source;
if (source) {
logger.info ("selected source: ", source);
if (this._adUnit) {
this._adUnit._src = source;
}
return callback(null, source, response);
}
// code 403 <== Couldn't find MediaFile that is supported by this video player
callback(new VASTError("Could not find Ad mediafile supported by this player", 403), response);
};
VASTIntegrator.prototype._createVASTTracker = function createVASTTracker(adMediaFile, response, callback) {
try {
callback(null, adMediaFile, new VASTTracker(adMediaFile.src, response), response);
} catch (e) {
callback(e, response);
}
};
VASTIntegrator.prototype._setupEvents = function setupEvents(adMediaFile, tracker, response, callback) {
var previouslyMuted;
var player = this.player;
player.on('fullscreenchange', trackFullscreenChange);
player.on('vast.adStart', trackImpressions);
player.on('pause', trackPause);
player.on('timeupdate', trackProgress);
player.on('volumechange', trackVolumeChange);
playerUtils.once(player, ['vast.adEnd', 'vast.adsCancel'], unbindEvents);
playerUtils.once(player, ['vast.adEnd', 'vast.adsCancel', 'vast.adSkip'], function(evt){
if(evt.type === 'vast.adEnd'){
tracker.trackComplete();
}
});
return callback(null, adMediaFile, response);
/*** Local Functions ***/
function unbindEvents() {
player.off('fullscreenchange', trackFullscreenChange);
player.off('vast.adStart', trackImpressions);
player.off('pause', trackPause);
player.off('timeupdate', trackProgress);
player.off('volumechange', trackVolumeChange);
}
function trackFullscreenChange() {
if (player.isFullscreen()) {
tracker.trackFullscreen();
} else {
tracker.trackExitFullscreen();
}
}
function trackPause() {
//NOTE: whenever a video ends the video Element triggers a 'pause' event before the 'ended' event.
// We should not track this pause event because it makes the VAST tracking confusing again we use a
// Threshold of 2 seconds to prevent false positives on IOS.
if (Math.abs(player.duration() - player.currentTime()) < 2) {
return;
}
tracker.trackPause();
playerUtils.once(player, ['play', 'vast.adEnd', 'vast.adsCancel'], function (evt) {
if(evt.type === 'play'){
tracker.trackResume();
}
});
}
function trackProgress() {
var currentTimeInMs = player.currentTime() * 1000;
tracker.trackProgress(currentTimeInMs);
}
function trackImpressions() {
tracker.trackImpressions();
tracker.trackCreativeView();
}
function trackVolumeChange() {
var muted = player.muted();
if (muted) {
tracker.trackMute();
} else Eif (previouslyMuted) {
tracker.trackUnmute();
}
previouslyMuted = muted;
}
};
VASTIntegrator.prototype._addSkipButton = function addSkipButton(source, tracker, response, callback) {
var skipOffsetInSec;
var that = this;
if (utilities.isNumber(response.skipoffset)) {
skipOffsetInSec = response.skipoffset / 1000;
addSkipButtonToPlayer(this.player, skipOffsetInSec);
}
callback(null, source, tracker, response);
/*** Local function ***/
function addSkipButtonToPlayer(player, skipOffset) {
var skipButton = createSkipButton(player);
var updateSkipButton = updateSkipButtonState.bind(that, skipButton, skipOffset, player);
player.el().appendChild(skipButton);
player.on('timeupdate', updateSkipButton);
playerUtils.once(player, ['vast.adEnd', 'vast.adsCancel'], removeSkipButton);
function removeSkipButton() {
player.off('timeupdate', updateSkipButton);
dom.remove(skipButton);
}
}
function createSkipButton(player) {
var skipButton = window.document.createElement("div");
dom.addClass(skipButton, "vast-skip-button");
skipButton.onclick = function (e) {
if (dom.hasClass(skipButton, 'enabled')) {
tracker.trackSkip();
player.trigger('vast.adSkip');
}
//We prevent event propagation to avoid problems with the clickThrough and so on
Eif (window.Event.prototype.stopPropagation !== undefined) {
e.stopPropagation();
} else {
return false;
}
};
return skipButton;
}
function updateSkipButtonState(skipButton, skipOffset, player) {
var timeLeft = Math.ceil(skipOffset - player.currentTime());
if (timeLeft > 0) {
skipButton.innerHTML = "Skip in " + utilities.toFixedDigits(timeLeft, 2) + "...";
} else {
if (!dom.hasClass(skipButton, 'enabled')) {
dom.addClass(skipButton, 'enabled');
skipButton.innerHTML = "Skip ad";
}
}
}
};
VASTIntegrator.prototype._addClickThrough = function addClickThrough(mediaFile, tracker, response, callback) {
var player = this.player;
var blocker = createClickThroughBlocker(player, tracker, response);
var updateBlocker = updateBlockerURL.bind(this, blocker, response, player);
player.el().insertBefore(blocker, player.controlBar.el());
player.on('timeupdate', updateBlocker);
playerUtils.once(player, ['vast.adEnd', 'vast.adsCancel'], removeBlocker);
return callback(null, mediaFile, tracker, response);
/*** Local Functions ***/
function createClickThroughBlocker(player, tracker, response) {
var blocker = window.document.createElement("a");
var clickThroughMacro = response.clickThrough;
dom.addClass(blocker, 'vast-blocker');
blocker.href = generateClickThroughURL(clickThroughMacro, player);
if (utilities.isString(clickThroughMacro)) {
blocker.target = "_blank";
}
blocker.onclick = function (e) {
if (player.paused()) {
player.play();
//We prevent event propagation to avoid problems with the player's normal pause mechanism
Eif (window.Event.prototype.stopPropagation !== undefined) {
e.stopPropagation();
}
return false;
}
player.pause();
tracker.trackClick();
};
return blocker;
}
function updateBlockerURL(blocker, response, player) {
blocker.href = generateClickThroughURL(response.clickThrough, player);
}
function generateClickThroughURL(clickThroughMacro, player) {
var variables = {
ASSETURI: mediaFile.src,
CONTENTPLAYHEAD: vastUtil.formatProgress(player.currentTime() * 1000)
};
return clickThroughMacro ? vastUtil.parseURLMacro(clickThroughMacro, variables) : '#';
}
function removeBlocker() {
player.off('timeupdate', updateBlocker);
dom.remove(blocker);
}
};
VASTIntegrator.prototype._playSelectedAd = function playSelectedAd(source, response, callback) {
var player = this.player;
player.preload("auto"); //without preload=auto the durationchange event is never fired
player.src(source);
logger.debug ("<VASTIntegrator._playSelectedAd> waiting for durationchange to play the ad...");
playerUtils.once(player, ['durationchange', 'error', 'vast.adsCancel'], function (evt) {
if (evt.type === 'durationchange') {
logger.debug ("<VASTIntegrator._playSelectedAd> got durationchange; calling playAd()");
playAd();
} else if(evt.type === 'error') {
callback(new VASTError("on VASTIntegrator, Player is unable to play the Ad", 400), response);
}
//NOTE: If the ads get canceled we do nothing/
});
/**** local functions ******/
function playAd() {
playerUtils.once(player, ['playing', 'vast.adsCancel'], function (evt) {
if(evt.type === 'vast.adsCancel'){
return;
}
logger.debug ("<VASTIntegrator._playSelectedAd/playAd> got playing event; triggering vast.adStart...");
player.trigger('vast.adStart');
player.on('ended', proceed);
player.on('vast.adsCancel', proceed);
player.on('vast.adSkip', proceed);
function proceed(evt) {
if(evt.type === 'ended' && (player.duration() - player.currentTime()) > 3 ) {
// Ignore ended event if the Ad time was not 'near' the end
// avoids issues where IOS controls could skip the Ad
return;
}
player.off('ended', proceed);
player.off('vast.adsCancel', proceed);
player.off('vast.adSkip', proceed);
//NOTE: if the ads get cancel we do nothing apart removing the listners
if(evt.type === 'ended' || evt.type === 'vast.adSkip'){
callback(null, response);
}
}
});
logger.debug ("<VASTIntegrator._playSelectedAd/playAd> calling player.play()...");
player.play();
}
};
VASTIntegrator.prototype._trackError = function trackError(error, response) {
vastUtil.track(response.errorURLMacros, {ERRORCODE: error.code || 900});
};
module.exports = VASTIntegrator; |