dev/js/src/init.js - KorAP/Kalamar - Gitiles

 /*
  * Initialize The JS frontend part and decorate
  * the static HTML data.
  *
  * @author Nils Diewald
  *
  * TODO: Create lazy loading of objects including
  * - obj.hint()
  * - obj.alertify()
  * - obj.session()
  * - obj.tutorial()
  * - obj.vc() // toggle
  * - obj.matchCreate() (using webpack)
  * - obj.koral() (show result, parse for errors ...)
  * - obj.alignment() // toggle
  */

 define([
   'match',
   'hint',
   'vc',
   'tutorial',
   'lib/domReady',
   'vc/array',
   'lib/alertify',
   'session',
   'selectMenu',
   'panel/result',
   'panel/query',
   'tour/tours',
   'plugin/server',
   'pipe',
   'api',
   'mailToChiffre',
   'util',
   'state'
 ], function (matchClass,
              hintClass,
              vcClass,
              tutClass,
              domReady,
              vcArray,
              alertifyClass,
              sessionClass,
              selectMenuClass,
              resultPanelClass,
              queryPanelClass,
              tourClass,
              pluginClass,
              pipeClass) {

   const d = document;

   // Create suffix if KorAP is run in a subfolder
   KorAP.session = sessionClass.create(
     KorAP.URL.length > 0 ? 'kalamarJS-' + KorAP.URL.slugify() : 'kalamarJS'
   );

   // Override KorAP.log
   window.alertify = alertifyClass;
   KorAP.log = function (code, msg, src) {

     if (src) {
       msg += '<code class="src">'+src+'</code>';
     };

     // Use alertify to log errors
     alertifyClass.log(
       (code === 0 ? '' : code + ': ') +
         msg,
       'error',
       10000
     );
   };

   KorAP.vc = vcClass.create(vcArray);

   KorAP.tourshow =  function(){
     tourClass.gTstartSearch().start();
   };

   KorAP.tourshowR = function(){
     tourClass.gTshowResults().start();
   };

   domReady(function (event) {

     var obj = {};

     // What should be visible in the beginning?
     var show = KorAP.session.get('show') || {};

     KorAP.Panel = KorAP.Panel || {}

     /**
      * Release notifications
      */
     if (KorAP.Notifications !== undefined) {
       KorAP.Notifications.forEach(function(n) {
         var msg = n[1];
         if (n[2]) {
           msg += '<code class="src">'+n[2]+'</code>';
         };
         alertifyClass.log(msg, n[0], 10000);
       });
     };

     /**
      * Replace Virtual Corpus field
      */
     var vcname, vcchoose;
     var input = d.getElementById('cq');

     var vc = KorAP.vc;

     // Add vc name object
     if (input) {
       input.style.display = 'none';
       vcname = d.createElement('span');
       vcname.setAttribute('id', 'vc-choose');
       vcname.classList.add('select');

       // Load virtual corpus object
       // Supports "collection" for legacy reasons
       if (KorAP.koralQuery !== undefined && (KorAP.koralQuery["collection"] || KorAP.koralQuery["corpus"])) {
         try {
           vc.fromJson(KorAP.koralQuery["collection"] || KorAP.koralQuery["corpus"]);
         }
         catch (e) {
           KorAP.log(0,e);
         }
       };

       vcchoose = vcname.addE('span');
       vcchoose.addT(vc.getName());

       if (vc.wasRewritten()) {
         vcchoose.classList.add('rewritten');
       };

       input.parentNode.insertBefore(vcname, input);
     };

     /**
      * Add actions to match entries
      */
     var matchElements = d.querySelectorAll(
       '#search > ol > li'
     );

     matchElements.forEach(function(e) {

       // Define class for active elements
       if (e.classList.contains('active')) {
         if (this._match === undefined) {
           // lazyLoad
           matchClass.create(e).init();
         };
       }

       // Define class for inactive elements
       else {
         e.addEventListener('click', function (e) {
           if (this._match !== undefined)
             this._match.open();
           else {
             // lazyLoad
             matchClass.create(this).open();
           };
           // This would prevent the sidebar to go back
           // e.halt();
         });
         e.addEventListener('keydown', function (e) {
           var code = _codeFromEvent(e);

           switch (code) {
           case 32:
             if (this._match !== undefined)
               this._match.toggle();
             else {
               // lazyLoad
               matchClass.create(this).open();
             };
             e.halt();
             break;
           };
         });
       };
     }, this);

     // Add focus listener to aside
     var aside = d.getElementsByTagName('aside')[0];

     if (aside && aside.classList.contains('active') == false) {

       // Horrible lock to deal with sidebar clicks
       var asideClicked = false;

       // Make aside active on focus
       aside.addEventListener('focus', function(e) {
         this.classList.add('active');
       });

       // Deactivate focus when clicking anywhere else
       var body = d.getElementsByTagName('body')[0];
       if (body !== null) {
         body.addEventListener('click', function() {
           if (!asideClicked) {
             aside.classList.remove('active');
           }
           else {
             asideClicked = false;
           };
         });
       };

       /* Stop click event on aside
        * (to not trickle down to body)
        */
       aside.addEventListener('click', function(e) {
         asideClicked = true;
       });
     };


     // Replace QL select menus with KorAP menus
     var qlField = d.getElementById('ql-field');
     if (qlField !== null) {
       KorAP.QLmenu = selectMenuClass.create(
         d.getElementById('ql-field').parentNode
       ).limit(5);
     };

     var resultInfo = d.getElementById('resultinfo');

     /**
      * Add result panel
      */
     var resultPanel = resultPanelClass.create(show);

     if (resultInfo != null) {

       // Move buttons to resultinfo
       resultInfo.appendChild(resultPanel.actions.element());

       // The views are at the top of the search results
       var sb = d.getElementById('search');
       sb.insertBefore(resultPanel.element(), sb.firstChild);
     };


     // There is a koralQuery
     if (KorAP.koralQuery !== undefined) {

       // Add KoralQuery view to result panel
       if (resultInfo !== null) {
         resultPanel.addKqAction()
       };

       if (KorAP.koralQuery["errors"]) {
         KorAP.koralQuery["errors"].forEach(function(e) {

           // Malformed query
           if (e[0] === 302 && e[2]) {
             obj.hint = hintClass.create();
             obj.hint.alert(e[2], e[1]);
           }

           // no query
           else if (e[0] === 301) {
             obj.hint = hintClass.create();
             obj.hint.alert(0, e[1]);
           }
         });
       };
     };


     /*
      * There is more than 0 matches, so allow for
      * alignment toggling (left <=> right)
      */
     if (matchElements.length > 0)
       resultPanel.addAlignAction();

     KorAP.Panel['result'] = resultPanel;
     /*
      * Toggle the Virtual Corpus builder
      */
     if (vcname) {
       vc.onMinimize = function () {
         vcname.classList.remove('active');
         delete show['vc'];
       };

       vc.onOpen = function () {
         vcname.classList.add('active');

         var view = d.getElementById('vc-view');
         if (!view.firstChild)
           view.appendChild(this.element());

         show['vc'] = true;
       };

       var vcclick = function () {
         if (vc.isOpen()) {
           vc.minimize()
         }
         else {
           vc.open();
         };
       };

       vcname.onclick = vcclick;

       // Click, if the VC should be shown
       if (show['vc']) {
         vcclick.apply();
       };
     };


     /**
      * Init Tutorial view
      */
     if (d.getElementById('view-tutorial')) {
       window.tutorial = tutClass.create(
         d.getElementById('view-tutorial'),
         KorAP.session
       );
       obj.tutorial = window.tutorial;
     }

     // Tutorial is in parent
     else if (window.parent) {
       obj.tutorial = window.parent.tutorial;
     };

     // Initialize queries for d
     if (obj.tutorial) {
       obj.tutorial.initQueries(d);

       // Initialize documentation links
       obj.tutorial.initDocLinks(d);
     };


     /**
      * Add VC creation on submission.
      */
     var form = d.getElementById('searchform');
     if (form !== null) {
       form.addEventListener('submit', function (e) {
         var qf = d.getElementById('q-field');

         // No query was defined
         if (qf.value === undefined || qf.value === '') {
           qf.focus();
           e.halt();
           KorAP.log(700, "No query given");
           return;
         };

         // Store session information
         KorAP.session.set("show", show);

         if (vc !== undefined) {
           input.value = vc.toQuery();
           if (input.value == '')
             input.removeAttribute('name');
         }
         else {
           input.removeAttribute('value');
           input.removeAttribute('name');
         };

         // This would preferably set the query to be "disabled",
         // but in that case the query wouldn't be submitted
         // at all.
         // Setting the cursor to "progress" fails in current versions
         // of webkit.
         qf.classList.add("loading");
         d.getElementById('qsubmit').classList.add("loading");
       });
     };


     //Starts the guided tour at the next page
     if(KorAP.session.get("tour")){
       tourClass.gTshowResults().start();
     }

     /**
      * Init hint helper
      * has to be final because of
      * reposition
      */
     // Todo: Pass an element, so this works with
     // tutorial pages as well!
     if (obj.hint === undefined)
       obj.hint = hintClass.create();

     // Add the hinthelper to the KorAP object to make it manipulatable globally
     KorAP.Hint = obj.hint;


     /**
      * Add query panel
      */
     var queryPanel = queryPanelClass.create();

     // Get input field
     var sform = d.getElementById("searchform");
     var vcView = d.getElementById('vc-view')
     if (sform && vcView) {
       // The views are below the query bar
       sform.insertBefore(queryPanel.element(), vcView);
       KorAP.Panel['query'] = queryPanel;
     }

     /**
      * Initialize Plugin registry.
      */
     let p = KorAP.Plugins;
     if (p && p.length > 0) {
       // Load Plugin Server first
       KorAP.Plugin = pluginClass.create();

       // Add services container to head
       d.head.appendChild(KorAP.Plugin.element());

       // Add pipe form
       KorAP.Pipe = pipeClass.create();
       d.getElementById("searchform").appendChild(KorAP.Pipe.element());

       try {

         // Register all plugins
         p.forEach(i => KorAP.Plugin.register(i));
       }
       catch (e) {
         KorAP.log(0, e);
       }
     };

     return obj;
   });

 });
	/*
	* Initialize The JS frontend part and decorate
	* the static HTML data.
	*
	* @author Nils Diewald
	*
	* TODO: Create lazy loading of objects including
	* - obj.hint()
	* - obj.alertify()
	* - obj.session()
	* - obj.tutorial()
	* - obj.vc() // toggle
	* - obj.matchCreate() (using webpack)
	* - obj.koral() (show result, parse for errors ...)
	* - obj.alignment() // toggle
	*/

	define([
	'match',
	'hint',
	'vc',
	'tutorial',
	'lib/domReady',
	'vc/array',
	'lib/alertify',
	'session',
	'selectMenu',
	'panel/result',
	'panel/query',
	'tour/tours',
	'plugin/server',
	'pipe',
	'api',
	'mailToChiffre',
	'util',
	'state'
	], function (matchClass,
	hintClass,
	vcClass,
	tutClass,
	domReady,
	vcArray,
	alertifyClass,
	sessionClass,
	selectMenuClass,
	resultPanelClass,
	queryPanelClass,
	tourClass,
	pluginClass,
	pipeClass) {

	const d = document;

	// Create suffix if KorAP is run in a subfolder
	KorAP.session = sessionClass.create(
	KorAP.URL.length > 0 ? 'kalamarJS-' + KorAP.URL.slugify() : 'kalamarJS'
	);

	// Override KorAP.log
	window.alertify = alertifyClass;
	KorAP.log = function (code, msg, src) {

	if (src) {
	msg += '<code class="src">'+src+'</code>';
	};

	// Use alertify to log errors
	alertifyClass.log(
	(code === 0 ? '' : code + ': ') +
	msg,
	'error',
	10000
	);
	};

	KorAP.vc = vcClass.create(vcArray);

	KorAP.tourshow = function(){
	tourClass.gTstartSearch().start();
	};

	KorAP.tourshowR = function(){
	tourClass.gTshowResults().start();
	};

	domReady(function (event) {

	var obj = {};

	// What should be visible in the beginning?
	var show = KorAP.session.get('show') \|\| {};

	KorAP.Panel = KorAP.Panel \|\| {}

	/**
	* Release notifications
	*/
	if (KorAP.Notifications !== undefined) {
	KorAP.Notifications.forEach(function(n) {
	var msg = n[1];
	if (n[2]) {
	msg += '<code class="src">'+n[2]+'</code>';
	};
	alertifyClass.log(msg, n[0], 10000);
	});
	};

	/**
	* Replace Virtual Corpus field
	*/
	var vcname, vcchoose;
	var input = d.getElementById('cq');

	var vc = KorAP.vc;

	// Add vc name object
	if (input) {
	input.style.display = 'none';
	vcname = d.createElement('span');
	vcname.setAttribute('id', 'vc-choose');
	vcname.classList.add('select');

	// Load virtual corpus object
	// Supports "collection" for legacy reasons
	if (KorAP.koralQuery !== undefined && (KorAP.koralQuery["collection"] \|\| KorAP.koralQuery["corpus"])) {
	try {
	vc.fromJson(KorAP.koralQuery["collection"] \|\| KorAP.koralQuery["corpus"]);
	}
	catch (e) {
	KorAP.log(0,e);
	}
	};

	vcchoose = vcname.addE('span');
	vcchoose.addT(vc.getName());

	if (vc.wasRewritten()) {
	vcchoose.classList.add('rewritten');
	};

	input.parentNode.insertBefore(vcname, input);
	};

	/**
	* Add actions to match entries
	*/
	var matchElements = d.querySelectorAll(
	'#search > ol > li'
	);

	matchElements.forEach(function(e) {

	// Define class for active elements
	if (e.classList.contains('active')) {
	if (this._match === undefined) {
	// lazyLoad
	matchClass.create(e).init();
	};
	}

	// Define class for inactive elements
	else {
	e.addEventListener('click', function (e) {
	if (this._match !== undefined)
	this._match.open();
	else {
	// lazyLoad
	matchClass.create(this).open();
	};
	// This would prevent the sidebar to go back
	// e.halt();
	});
	e.addEventListener('keydown', function (e) {
	var code = _codeFromEvent(e);

	switch (code) {
	case 32:
	if (this._match !== undefined)
	this._match.toggle();
	else {
	// lazyLoad
	matchClass.create(this).open();
	};
	e.halt();
	break;
	};
	});
	};
	}, this);

	// Add focus listener to aside
	var aside = d.getElementsByTagName('aside')[0];

	if (aside && aside.classList.contains('active') == false) {

	// Horrible lock to deal with sidebar clicks
	var asideClicked = false;

	// Make aside active on focus
	aside.addEventListener('focus', function(e) {
	this.classList.add('active');
	});

	// Deactivate focus when clicking anywhere else
	var body = d.getElementsByTagName('body')[0];
	if (body !== null) {
	body.addEventListener('click', function() {
	if (!asideClicked) {
	aside.classList.remove('active');
	}
	else {
	asideClicked = false;
	};
	});
	};

	/* Stop click event on aside
	* (to not trickle down to body)
	*/
	aside.addEventListener('click', function(e) {
	asideClicked = true;
	});
	};


	// Replace QL select menus with KorAP menus
	var qlField = d.getElementById('ql-field');
	if (qlField !== null) {
	KorAP.QLmenu = selectMenuClass.create(
	d.getElementById('ql-field').parentNode
	).limit(5);
	};

	var resultInfo = d.getElementById('resultinfo');

	/**
	* Add result panel
	*/
	var resultPanel = resultPanelClass.create(show);

	if (resultInfo != null) {

	// Move buttons to resultinfo
	resultInfo.appendChild(resultPanel.actions.element());

	// The views are at the top of the search results
	var sb = d.getElementById('search');
	sb.insertBefore(resultPanel.element(), sb.firstChild);
	};


	// There is a koralQuery
	if (KorAP.koralQuery !== undefined) {

	// Add KoralQuery view to result panel
	if (resultInfo !== null) {
	resultPanel.addKqAction()
	};

	if (KorAP.koralQuery["errors"]) {
	KorAP.koralQuery["errors"].forEach(function(e) {

	// Malformed query
	if (e[0] === 302 && e[2]) {
	obj.hint = hintClass.create();
	obj.hint.alert(e[2], e[1]);
	}

	// no query
	else if (e[0] === 301) {
	obj.hint = hintClass.create();
	obj.hint.alert(0, e[1]);
	}
	});
	};
	};


	/*
	* There is more than 0 matches, so allow for
	* alignment toggling (left <=> right)
	*/
	if (matchElements.length > 0)
	resultPanel.addAlignAction();

	KorAP.Panel['result'] = resultPanel;
	/*
	* Toggle the Virtual Corpus builder
	*/
	if (vcname) {
	vc.onMinimize = function () {
	vcname.classList.remove('active');
	delete show['vc'];
	};

	vc.onOpen = function () {
	vcname.classList.add('active');

	var view = d.getElementById('vc-view');
	if (!view.firstChild)
	view.appendChild(this.element());

	show['vc'] = true;
	};

	var vcclick = function () {
	if (vc.isOpen()) {
	vc.minimize()
	}
	else {
	vc.open();
	};
	};

	vcname.onclick = vcclick;

	// Click, if the VC should be shown
	if (show['vc']) {
	vcclick.apply();
	};
	};


	/**
	* Init Tutorial view
	*/
	if (d.getElementById('view-tutorial')) {
	window.tutorial = tutClass.create(
	d.getElementById('view-tutorial'),
	KorAP.session
	);
	obj.tutorial = window.tutorial;
	}

	// Tutorial is in parent
	else if (window.parent) {
	obj.tutorial = window.parent.tutorial;
	};

	// Initialize queries for d
	if (obj.tutorial) {
	obj.tutorial.initQueries(d);

	// Initialize documentation links
	obj.tutorial.initDocLinks(d);
	};


	/**
	* Add VC creation on submission.
	*/
	var form = d.getElementById('searchform');
	if (form !== null) {
	form.addEventListener('submit', function (e) {
	var qf = d.getElementById('q-field');

	// No query was defined
	if (qf.value === undefined \|\| qf.value === '') {
	qf.focus();
	e.halt();
	KorAP.log(700, "No query given");
	return;
	};

	// Store session information
	KorAP.session.set("show", show);

	if (vc !== undefined) {
	input.value = vc.toQuery();
	if (input.value == '')
	input.removeAttribute('name');
	}
	else {
	input.removeAttribute('value');
	input.removeAttribute('name');
	};

	// This would preferably set the query to be "disabled",
	// but in that case the query wouldn't be submitted
	// at all.
	// Setting the cursor to "progress" fails in current versions
	// of webkit.
	qf.classList.add("loading");
	d.getElementById('qsubmit').classList.add("loading");
	});
	};


	//Starts the guided tour at the next page
	if(KorAP.session.get("tour")){
	tourClass.gTshowResults().start();
	}

	/**
	* Init hint helper
	* has to be final because of
	* reposition
	*/
	// Todo: Pass an element, so this works with
	// tutorial pages as well!
	if (obj.hint === undefined)
	obj.hint = hintClass.create();

	// Add the hinthelper to the KorAP object to make it manipulatable globally
	KorAP.Hint = obj.hint;


	/**
	* Add query panel
	*/
	var queryPanel = queryPanelClass.create();

	// Get input field
	var sform = d.getElementById("searchform");
	var vcView = d.getElementById('vc-view')
	if (sform && vcView) {
	// The views are below the query bar
	sform.insertBefore(queryPanel.element(), vcView);
	KorAP.Panel['query'] = queryPanel;
	}

	/**
	* Initialize Plugin registry.
	*/
	let p = KorAP.Plugins;
	if (p && p.length > 0) {
	// Load Plugin Server first
	KorAP.Plugin = pluginClass.create();

	// Add services container to head
	d.head.appendChild(KorAP.Plugin.element());

	// Add pipe form
	KorAP.Pipe = pipeClass.create();
	d.getElementById("searchform").appendChild(KorAP.Pipe.element());

	try {

	// Register all plugins
	p.forEach(i => KorAP.Plugin.register(i));
	}
	catch (e) {
	KorAP.log(0, e);
	}
	};

	return obj;
	});

	});