Code Difference Highlighting Tutorial
โœ‚๐Ÿƒ๐Ÿพโ€โ™€๏ธ๐Ÿƒ๐Ÿผโ€โ™‚๏ธ
๐Ÿ“–

Code Difference Highlighting Tutorial

Code Difference Highlighting Tutorial

We last mentioned our inhouse PHP code difference mechanism with โ€ฆ

It meant, in that scenario yesterday, when a single variable usage โ€œtells a storyโ€ in the code, this code difference highlighting might be more effective at explaining the issues rather than showing the code in a code element (even with inhouse colour coding), because there is also the โ€œbeforeโ€ and โ€œafterโ€ scenarios there on the screen for the reader to contextualize. See the newly changed PHP diffphp code or try it yourself here.



Previous relevant Code Difference Saved User Settings Tutorial is shown below.

Code Difference Saved User Settings Tutorial

Code Difference Saved User Settings Tutorial

As a PHP programmer it is easy to admire โ€ฆ

  • the server side file and database and operating system smarts of the great serverside language PHP is โ€ฆ all while โ€ฆ
  • PHP writing out HTML (with its CSS and Javascript) has a web application able to access all that clientside intelligence

โ€ฆ and with this in mind, we allow for saved CSS styling user settings, as of today, with our Difference Report web application arrangements.

Donโ€™t we need a database for this? Well, that is possible, and with serverside PHP, could be done, but we opt for clientside window.localStorage usage to โ€ฆ

  • Save user CSS styling settings
  • Recall user CSS styling settings

โ€ฆ so that a user might opt to โ€œset and forgetโ€ their preferred set of โ€ฆ

  • New additional
  • Changed single line
  • New block of lines
  • Deleted lines
  • Changed multiple lines

โ€ฆ (CSS Selector) sensitive โ€œcategoriesโ€ of Difference Report data type settings.

As a result, building on yesterdayโ€™s Code Difference User Settings Tutorial, the deployment of CSS selector logic, in PHP, now changes to โ€ฆ

<?php


$style="<style> font { text-shadow: -1px 1px 1px #ff2d95; } </style>";

$legend="";

$mx="";

$onecommand=" function nocaret(invx) { var outvx=decodeURIComponent(invx); while (outvx.indexOf('<') > outvx.indexOf('>')) { outvx=outvx.replace('>' + outvx.split('>')[1].split('<')[0] + '<',''); } return encodeURIComponent(outvx); } function onb(event) { var othis=event.target, cih=''; if (('' + othis.id + ' ').substring(0,1) == 'f') { cih=('' + window.localStorage.getItem('diff_' + othis.id)).replace(/^undefined$/g,''.replace(/^null$/g,'')); if (('' + othis.innerHTML.replace(/\ \;/g,' ') + '~~').indexOf(' ~~') != -1) { if (cih == '') { window.localStorage.setItem('diff_' + othis.id, encodeURIComponent('14 >' + othis.innerText + '<')); } else { window.localStorage.removeItem('diff_' + othis.id); window.localStorage.setItem('diff_' + othis.id, nocaret(cih) + encodeURIComponent(' >' + othis.innerText + '<')); } } } } function blurize(othis) { if (1 == 2) { othis.onblur=function(event) { onb(event); }; } return othis; } function perhapsih(insg,ofo) { if (insg.indexOf('<') > insg.indexOf('<') && insg.indexOf('<') != -1) { ofo.innerHTML=insg.split('>')[1].split('>')[0]; ofo.setAttribute('data-ih', insg.split('>')[1].split('>')[0]); return insg.replace('>' + insg.split('>')[1].split('>')[0] + '<', ''); } } function givef(idn,cssis) { if (('' + document.getElementById('f' + idn).title).indexOf(' ' + decodeURIComponent(cssis) + ' ') == -1) { document.getElementById('f' + idn).title=document.getElementById('lspan').title + ' You have user CSS styling friendly one off setting of ' + decodeURIComponent(cssis) + ' for this category of Difference Reporting'; } } function getmaybe(foin,defis) { var mgs=document.URL.split(foin.id + '='); thatget=('' + window.localStorage.getItem('diff_' + foin.id)).replace(/^undefined$/g,'').replace(/^null$/g,''); if (thatget != '') { if (eval('' + mgs.length) == 1) { return decodeURIComponent(thatget); } else if (mgs[1].split('&')[0].split('#')[0] == '') { return decodeURIComponent(thatget); } } if (eval('' + mgs.length) > 1) { if (mgs[1].split('&')[0].split('#')[0] != '') { return decodeURIComponent(mgs[1].split('&')[0].split('#')[0]); } } return defis; } function getany() { var mgs=[],addget='',thisget=''; if (document.URL.replace('?','&').indexOf('&f') == -1 || 1 == 1) { for (var iig=0; iig<=6; iig++) { mgs=document.URL.split('f' + iig + '='); thisget=('' + window.localStorage.getItem('diff_f' + iig)).replace(/^undefined$/g,'').replace(/^null$/g,''); if (thisget != '') { document.getElementById('f' + iig).title=document.getElementById('lspan').title + ' You have user CSS styling friendly setting of ' + decodeURIComponent(thisget) + ' for this category of Difference Reporting'; } if (eval('' + mgs.length) > 1) { if (mgs[1].split('&')[0].split('#')[0] != '') { document.getElementById('f' + iig).title=document.getElementById('lspan').title + ' You have user CSS styling friendly setting of ' + decodeURIComponent(mgs[1].split('&')[0].split('#')[0]) + ' for this category of Difference Reporting'; } } if (document.URL.replace('?','&').indexOf('&f' + iig + '=') == -1) { addget+='&f' + iig + '=' + thisget; } } } if (addget != '') { location.href=(document.URL.split('#')[0] + addget).replace('.php&','.php?'); } } setTimeout(getany,2000); function removeany(newfo) { window.localStorage.removeItem('diff_' + newfo.id); } function addany(newishfo,newwhat) { removeany(newishfo); window.localStorage.setItem('diff_' + newishfo.id, newwhat); } function askabout(fo) { var defd='14', ccol='black', ccols=fo.outerHTML.split(' color=' + String.fromCharCode(34)), psizes=fo.outerHTML.split('px'); if (eval('' + ccols.length) > 1) { ccol=ccols[1].split(String.fromCharCode(34))[0]; } if (eval('' + psizes.length) > 1) { defd=psizes[0].split(':')[eval(-1 + psizes[0].split(':').length)].trim(); } var numis=prompt('How many px (ie. pixels) do you want for the font size of these ' + fo.innerHTML + ' parts of report? Optionally append after a space a colour that is not the default colour ' + ccol + ' for this category of difference report. Optionally append after a space any other styling you want ( eg. text-shadow: -1px 1px 1px #ff2d95; ). Append spaces to save for other Coding Difference Report sessions into the future. Prefix with minus ( ie. - ) to forget any remembered setting. An entry can be > followed by a new wording for this category followed by <', getmaybe(fo,defd)); if (numis != null) { if ((perhapsih(numis,fo) + 'x').trim().substring(0,1) == '-') { removeany(fo); numis=numis.replace('-',''); } if (('' + numis).trim() != '') { if (numis.replace(/\ $/g,'') != numis) { addany(fo,encodeURIComponent(numis.trim())); } location.href=(document.URL.split('#')[0] + '&' + fo.id + '=' + encodeURIComponent(numis.trim())).replace('.php&','.php?'); } } } ";

if (isset($_GET['f0']) || isset($_GET['f1']) || isset($_GET['f2']) || isset($_GET['f3']) || isset($_GET['f4']) || isset($_GET['f5']) || isset($_GET['f6'])) {

$onecommand.=" function sizefonts() { } setTimeout(sizefonts, 3000); ";

for ($ij=0; $ij<=6; $ij++) {

if (isset($_GET['f' . $ij])) {

$ihbit="";

$words=str_replace('+',' ',urldecode($_GET['f' . $ij]));

if (strpos($words, '<') !== false && strpos($words, '>') !== false) {

if (strpos($words, '<') > strpos($words, '>')) {

$ihbit=" document.getElementById('f" . $ij . "').innerHTML='" . str_replace("'", "' + String.fromCharCode(39) + '", explode('<',explode('>',$words)[1])[0]) . "'; ";

}

}

if (trim($words) != '') { $onecommand=str_replace("} ", " givef(" . $ij . ",'" . $_GET['f' . $ij] . "'); } ", $onecommand); }

$wordsa=explode(' ', trim($words));

if (sizeof($wordsa) > 1) {

$words=substr($words,(1 + strlen($wordsa[0])));

for ($ijj=1; $ijj<sizeof($wordsa); $ijj++) {

if (strpos($wordsa[$ijj], ':') === false && $ijj == 1) {

$words=trim(substr($words,(0 + strlen($wordsa[$ijj]))));

$style.='<style> .f' . $ij . " { font-color: " . trim($wordsa[$ijj]) . '; } </style>';

$onecommand=str_replace("} ", " document.getElementById('f" . $ij . "').color='' + '" . trim($wordsa[$ijj]) . "'; document.getElementById('f" . $ij . "').style.fontColor='' + '" . trim($wordsa[$ijj]) . "'; } ", $onecommand);

}

}

if (trim($words) != '') {

if (strpos($words, "{") !== false && strpos($words, "}") !== false) {

$style.='<style> ' . $words . ' </style>';

$onecommand=str_replace("} ", " document.getElementById('dstyle').innerHTML+='<style> ' + '" . $words . " </style>'; } ", $onecommand);

} else {

$style.='<style> .f' . $ij . " { " . $words . ' } </style>';

$onecommand=str_replace("} ", " document.getElementById('dstyle').innerHTML+='<style> .f" . $ij . " { ' + '" . $words . " } </style>'; } ", $onecommand);

}

}

}

$onecommand=str_replace("} ", $ihbit . " document.getElementById('f" . $ij . "').style.fontSize='' + '" . trim($wordsa[0]) . "px'; } ", $onecommand);

$style.='<style> .f' . $ij . " { font-size: " . trim($wordsa[0]) . 'px; } </style>';

}

}

}


?>

โ€ฆ to start making this happen (including being able to change our โ€œinhouse categoryโ€ names, if you like) in ourchanged diffphpโ€˜s more colourful Codeโœ‚Differences helper.


Previous relevant Code Difference User Settings Tutorial is shown below.

Code Difference User Settings Tutorial

Code Difference User Settings Tutorial

Yesterdayโ€™s Code Difference Privacy Tutorial represented too much of an echo chamber for our liking. Where possible, we prefer functionality that the users out there can tweak themselves.

In thinking about this, those 5 categories (involving 2 subcategories) โ€ฆ

  • New additional
  • Changed single line
  • New block of lines
  • Deleted lines
  • Changed multiple lines

โ€ฆ were what occurred to us could be the CSS Selector basis for us to improve the Code Difference reporting via CSS styling functionality.

Up to today the deployment of that CSS selector logic would have had to be more complex than necessary, but todayโ€™s โ€ฆ

  • giving new id and class attributes to the โ€œlegendโ€ span id=lspan elements โ€ฆ and โ€ฆ
  • equivalent class attribute to report matching element data

โ€ฆ makes the deployment of CSS selector logic really easy, in PHP, as per โ€ฆ

<?php


$style="<style> font { text-shadow: -1px 1px 1px #ff2d95; } </style>";

$legend="";

$mx="";

$onecommand=" function askabout(fo) { var defd='14', ccol='black', ccols=fo.outerHTML.split(' color=' + String.fromCharCode(34)), psizes=fo.outerHTML.split('px'); if (eval('' + ccols.length) > 1) { ccol=ccols[1].split(String.fromCharCode(34))[0]; } if (eval('' + psizes.length) > 1) { defd=psizes[0].split(':')[eval(-1 + psizes[0].split(':').length)].trim(); } var numis=prompt('How many px (ie. pixels) do you want for the font size of these ' + fo.innerHTML + ' parts of report? Optionally append after a space a colour that is not the default colour ' + ccol + ' for this category of difference report. Optionally append after a space any other styling you want ( eg. text-shadow: -1px 1px 1px #ff2d95; )', defd); if (numis != null) { if (('' + numis).trim() != '') { location.href=(document.URL.split('#')[0] + '&' + fo.id + '=' + encodeURIComponent(numis.trim())).replace('.php&','.php?'); } } } ";

if (isset($_GET['f0']) || isset($_GET['f1']) || isset($_GET['f2']) || isset($_GET['f3']) || isset($_GET['f4']) || isset($_GET['f5']) || isset($_GET['f6'])) {

$onecommand.=" function sizefonts() { } setTimeout(sizefonts, 3000); ";

for ($ij=0; $ij<=6; $ij++) {

if (isset($_GET['f' . $ij])) {

$words=str_replace('+',' ',urldecode($_GET['f' . $ij]));

$wordsa=explode(' ', trim($words));

if (sizeof($wordsa) > 1) {

$words=substr($words,(1 + strlen($wordsa[0])));

for ($ijj=1; $ijj<sizeof($wordsa); $ijj++) {

if (strpos($wordsa[$ijj], ':') === false && $ijj == 1) {

$words=trim(substr($words,(0 + strlen($wordsa[$ijj]))));

$style.='<style> .f' . $ij . " { font-color: " . trim($wordsa[$ijj]) . '; } </style>';

$onecommand=str_replace("} ", " document.getElementById('f" . $ij . "').color='' + '" . trim($wordsa[$ijj]) . "'; document.getElementById('f" . $ij . "').style.fontColor='' + '" . trim($wordsa[$ijj]) . "'; } ", $onecommand);

}

}

if (trim($words) != '') {

if (strpos($words, "{") !== false && strpos($words, "}") !== false) {

$style.='<style> ' . $words . ' </style>';

$onecommand=str_replace("} ", " document.getElementById('dstyle').innerHTML+='<style> ' + '" . $words . " </style>'; } ", $onecommand);

} else {

$style.='<style> .f' . $ij . " { " . $words . ' } </style>';

$onecommand=str_replace("} ", " document.getElementById('dstyle').innerHTML+='<style> .f" . $ij . " { ' + '" . $words . " } </style>'; } ", $onecommand);

}

}

}

$onecommand=str_replace("} ", " document.getElementById('f" . $ij . "').style.fontSize='' + '" . trim($wordsa[0]) . "px'; } ", $onecommand);

$style.='<style> .f' . $ij . " { font-size: " . trim($wordsa[0]) . 'px; } </style>';

}

}

}


?>

โ€ฆ user tweakable (using window.prompt interactive entry) via clickable โ€œlegendโ€ elements in ourchanged diffphpโ€˜s more colourful Codeโœ‚Differences helper.


Previous relevant Code Difference Privacy Tutorial is shown below.

Code Difference Privacy Tutorial

Code Difference Privacy Tutorial

Yesterdayโ€™s Code Difference Colour Coding Tutorial Difference Report modifications (still) had the inherent weakness โ€ฆ

  • it was possible, but unlikely, for users to see other user generated reports, if they happened to be asking for reports at exactly the same time โ€ฆ because โ€ฆ
  • we had not catered for busy traffic here โ€ฆ but, today โ€ฆ
  • we cater, better, for busy online traffic โ€ฆ and at the same time โ€ฆ
  • improve the privacy of the reporting on an IP address basis

The downside, at least for us managing this, is that we do not want a build up of files belonging to difference reports long gone. We arrange it, then, that as soon as the report is created, a window.open scenario is coded for โ€ฆ

<?php


$legend=' <span id=lspan><span><font size=2 color=purple>New additional</font></span> <span><font size=2 color=magenta>Changed single </font><font size=2 color=indigo> line</font></span> <span><font size=2 color=blue>New block of lines</font></span> <span><font size=2 color=orange>Deleted lines</font></span> <span><font size=2 color=darkgreen>Changed multiple </font><font size=2 color=olive>lines</font> <a id=myaa onclick="var wod=window.open(' . "'','_blank','left=100,top=100,width=600,height=600'" . '); wod.document.write(' . "'<textarea title=' + document.URL + ' cols=120 rows=40 style=background-color:pink;>' + " . 'window.atob(' . "'" . trim(base64_encode(file_get_contents("huh" . server_remote_addr() . ".huh"))) . "'" . ') + ' . "'</textarea>'" . '); wod.document.title=document.URL; " style=text-decoration:underline;cursor:pointer;>Original ...</a></span></span>';



$onecommand=" function muchl() { if (document.getElementById('lspan').innerHTML.indexOf(\".atob('')\") != -1) { document.getElementById('lspan').innerHTML=document.getElementById('lspan').innerHTML.replace(\".atob('')\", \".atob('" . trim(base64_encode(file_get_contents("huh" . server_remote_addr() . ".huh"))) . "')\"); } } setTimeout(muchl,8000); ";


?>

โ€ฆ leaving the door open for us to tidy up straight away in ourchanged diffphpโ€˜s more colourful Codeโœ‚Differences helper.


Previous relevant Code Difference Colour Coding Tutorial is shown below.

Code Difference Colour Coding Tutorial

Code Difference Colour Coding Tutorial

Itโ€™s coming up to a few years now, since we looked at the code differences reporting we offer the reader, as a way to scrutinize code changes, around here, when we presented Code Download Table Difference Functional Hover Tutorial. Well, we thought we might try some colour coding to perhaps lift the fog on the cryptic nature of Linux diff (difference) command based reports. They can be cryptic because they can feed into the automation feeding of the report into other Linux commands to facilitate ongoing editing endeavours, but we do not want to go into that here, at least today.

But on examining the reports we came up with the following difference report โ€œcategoriesโ€ if you will โ€ฆ

  • New additional
  • Changed single line
  • New block of lines
  • Deleted lines
  • Changed multiple lines

โ€ฆ the header (of a block of interest) the dead give away, depending on the existence of โ€œaโ€ or โ€œcโ€ or โ€œdโ€ and/or โ€œ,โ€ for a common sense reinterpretation by us not visiting โ€œman diffโ€ ourselves, yet, regarding this work.

Feel free to take a look at ourchanged diffphpโ€˜s more colourful Codeโœ‚Differences helper.


Previous relevant Code Download Table Difference Functional Hover Tutorial is shown below.

Code Download Table Multiple Row Email Hover Tutorial

Code Download Table Difference Functional Hover Tutorial

Is it worth adding โ€œonmouseoverโ€ event logic onto yesterdayโ€™s Code Download Table Difference Functional Linking Tutorial? You bet it is! Just because โ€œonmouseoverโ€ has no relevance to mobile platforms, so, obversely, developing software with version control systems is irrelevant to mobile platforms.

โ€ฆ a place for everything and everything in its place โ€ฆ

โ€ฆ we figure. But this is of relevance to the programmer. Sometimes, rather than cater for all the platforms, settling on a subset (of those platforms) can be apt because โ€ฆ

  • one of mobile or non-mobile subsets of platforms is irrelevant to the scenario โ€ฆ as for today โ€ฆ or โ€ฆ
  • you try to reinvent the wheel on the pretext that you are waiting for a particular web browser or platform to allow the functionality in, into the future โ€ฆ you could be waiting a while, with the complexity of app arrangements going on around the net these days

Anyway, back to the โ€œonmouseoverโ€ event on non-mobile platforms โ€ฆ it was the case that this event was a favourite for the conduit towards Ajax (client) functionality. And thinking on what we do today to nuance our Code Differences PHP web application, we were thinking โ€ฆ

What would Ajax (like to) do?

โ€ฆ and we decided Ajax would really like to โ€ฆ

  • populate a โ€œdivโ€ style=display:inline-block; element adjacent to the functional detail to inform about โ€ฆ but this was not possible โ€ฆ so, instead, we โ€ฆ
  • populate a popup window near to the functional detail to inform about

โ€ฆ for a non-mobile โ€œhoverโ€ (ie. โ€œonmouseoverโ€) event.

Along the way we add some more hashtag navigations and set up more colour coding to the output of (the optional) โ€œfunctional linksโ€ Code Difference reporting.

So take a look at ourchanged diffphp Code Differences helper applied to itself below โ€ฆ


Previous relevant Code Download Table Multiple Row Email Report Tutorial is shown below.

Code Download Table Multiple Row Email Report Tutorial

Code Download Table Multiple Row Email Report Tutorial

Before leaving yesterdayโ€™s Download and Copy or Move Code Download Table Tutorial extensions to our Code Download Table functionality โ€ฆ

  • add copy onto a download functionality to the Code Download Table โ€ฆ today, we โ€ฆ
  • add a Multiple Row selection basis for a personalized Email Report for the user

โ€ฆ as we saw that there was scope for this as a sharing mechanism for project discussions and ideas, we hope.

Todayโ€™s tutorial picture tries to show the steps to emailing off a report of interest to a user โ€ฆ

  1. User clicks the โ€œAllow Multiple Row Clicksโ€ checkbox โ€ฆ


    prefixask=prefixask.replace('</div>', '<div id=divawrc style=display:inline-block;>  Allow Multiple Row Clicks <input onchange="domrows();" id=awrc style=inline-block; type=checkbox></input> <div id=dawrc style=display:inline-block;></div></div></div>');


    โ€ฆ which causes โ€ฆ
  2. โ€œReportโ€ button shows to its right โ€ฆ


    function domrows() {

    document.getElementById('dawrc').innerHTML='<input style=inline-block; type=button onclick=treportdo(); value=Report></input>';

    var trsis=document.getElementsByTagName('tr');

    for (var itrsis=0; itrsis<trsis.length; itrsis++) {

    trsis[itrsis].onclick = function(e) { if (e.target.innerHTML != '') { var trs=document.getElementsByTagName('tr'); for (var itrs=0; itrs<trs.length; itrs++) { if (trs[itrs].outerHTML.indexOf(e.target.innerHTML) != -1) { trs[itrs].style.border='2px dotted red'; } } } };

    }

    }


    โ€ฆ and table row onclick logic is dynamically applied to those โ€œtrโ€ elements
  3. User clicks somewhere within rows they are interested in seeing be included in a report (which is a snippet of the whole Code Download Table, perhaps to do with a project of interest, or a learning topic of interest)
  4. User optionally clicks the โ€œReportโ€ button โ€ฆ


    function treportdo() {

    var trsis=document.getElementsByTagName('tr');

    webc='<html><head><script type="text/javascript"> function emailto(eto) { window.opener.parentemailto(eto); } function xemailto(eto) { if (eto.indexOf("@") != -1) { var zhr=new XMLHttpRequest(); var zform=new FormData(); zform.append("inline",""); zform.append("to",eto); zform.append("subj","Code Download Table part"); zform.append("body",document.getElementById("mytable").outerHTML); zhr.open("post", "//www.rjmprogramming.com.au/HTMLCSS/emailhtml.php", true); zhr.send(zform); alert("Email sent to " + eto); } } </script></head><body><table id=mytable></table><br><br><br><input onblur=emailto(this.value); placeholder="Email to" type=email></input></body></html>';

    for (var itrsis=0; itrsis<trsis.length; itrsis++) {

    if (itrsis == 0) {

    webc=webc.replace('</table>', trsis[itrsis].outerHTML + '</table>');

    }

    if (trsis[itrsis].outerHTML.indexOf('>') > trsis[itrsis].outerHTML.indexOf('border:')) {

    if (trsis[itrsis].outerHTML.indexOf('dotted') > trsis[itrsis].outerHTML.indexOf('border:')) {

    webc=webc.replace('</table>', trsis[itrsis].outerHTML + '</table>');

    }

    }

    }

    var woois=window.open('','_blank','top=20,left=20,width=600,height=600');

    woois.document.write(webc);

    }


    โ€ฆ which causes a โ€ฆ
  5. New popup window opens showing the relevant snippet of Code Download Table of interest to the user โ€ฆ including โ€ฆ
  6. Textbox for an optional emailee entry that can be filled in โ€ฆ to โ€ฆ
  7. Set off Ajax/FormData methodology means โ€ฆ


    function parentemailto(eto) {

    if (eto.indexOf("@") != -1) {

    var zhr=new XMLHttpRequest();

    var zform=new FormData();

    zform.append("inline","");

    zform.append("to",eto);

    zform.append("subj","RJM Programming Code Download Table part");

    zform.append("body", reltoabs('<table' + webc.split('</table>')[0].split('<table')[1] + '</table>'));

    zhr.open("post", "//www.rjmprogramming.com.au/HTMLCSS/emailhtml.php", true);

    zhr.send(zform);

    alert("Email sent to " + eto);

    }

    }


    โ€ฆ to send off an Inline HTML Email report to the emailee โ€ฆ including โ€ฆ
  8. Links of email can be clicked to get back to source code and other links back at the RJM Programming domain web server

โ€ฆ in ourchanged getmelistโšซjs external Javascript code file (that you can try out for yourself at this liveโœ‚run link).


Previous relevant Download and Copy or Move Code Download Table Tutorial is shown below.

Download and Copy or Move Code Download Table Tutorial

Download and Copy or Move Code Download Table Tutorial

After the โ€œgoings onโ€ with the relatively recent PHP Blog Summary Fixed Title Events Tutorial we thought we were finished with โ€œCode Download Tableโ€ functionality โ€ฆ but then โ€ฆ

โ€ฆ along came Jones yesterdayโ€™s Download and Copy or Move Server Tutorial โ€ฆ

โ€ฆ and โ€ฆ lo and behold โ€ฆ we saw a good use for the idea of โ€ฆ

  1. download from โ€œthe netโ€ to a Downloads folder on your computer or device โ€ฆ and more often than not โ€ฆ
  2. you, the user, copies or renames this data to another location on your computer or device with command line or with operating system GUI

โ€ฆ and allowing for that second step above be programmatical with the most apt functionality that had ever passed our cotton pickinโ€™ mind โ€ฆ our Code Download Table โ€ฆ wiโ€™ all thoโ€™ GETMEโ€™s!

But we donโ€™t want to interfere too much with the Code Download Table โ€œflowโ€ here, so create up the top left 20 seconds worth of time (extendable by their actions) available to the user to create โ€œdownloadโ€ attributes on all โ€ฆ

  • โ€œaโ€ links โ€ฆ with โ€ฆ
  • โ€œhrefโ€ attribute containing โ€œGETMEโ€ โ€ฆ
  • but not โ€œdiff.phpโ€ โ€ฆ and โ€ฆ
  • โ€œdownloadโ€ attribute (the attribute necessary to โ€œdownloadโ€ rather than our default displaying of source code in a new webpage)

โ€ฆ plus no href attribute containing โ€œ?s=โ€ either, for todayโ€™s purposes with achanged getmelistโšซjs external Javascript code file (that you can try out for yourself at this liveโœ‚run link) โ€ฆ via its new โ€ฆ



var dnprefix=decodeURIComponent(('' + localStorage.getItem('download_copy_to_folder')).replace(/^null$/g,'')); //.replace(/\+/g,' ').replace(/\\\\/g, '_').replace(/\//g, '_').replace(/\:/g, '_');

var delaymore=0;

var prefixask='<div id=firstask style="position:absolute;top:0px;left:0px;"> Download GETME? <input id=dpccb style=inline-block; type=checkbox onchange="dogetmes(document.getElementById(' + "'" + 'dpcis' + "'" + ').value);"></input> <input style=inline-block;width:300px; onclick="delaymore+=20000;" onblur="if (document.getElementById(' + "'" + 'dpccb' + "'" + ').checked) { dogetmes(document.getElementById(this.value); }" type=text id=dpcis placeholder="Optional Download Folder Later Copy to Place via Listener" value="' + dnprefix + '"></input></div>';



function dogetmes(dpprefix) {

delaymore+=20000;

var asis=document.getElementsByTagName('a');

if (dpprefix != dnprefix && 1 == 7) {

localStorage.setItem('download_copy_to_folder', dpprefix);

}

for (var iasis=0; iasis<asis.length; iasis++) {

if (asis[iasis].href.indexOf('diff.php') == -1 && asis[iasis].href.indexOf('?s=') == -1 && asis[iasis].href.indexOf('GETME') != -1) {

asis[iasis].download=dpprefix.replace(/\//g,'_').replace(/\\\\/g,'_').replace(/\:/g,'_') + asis[iasis].href.split('/')[eval(-1 + asis[iasis].href.split('/').length)];

}

}

}



function nomorepa() {

if (eval('' + delaymore) == 0) {

if (document.getElementById('firstask')) {

document.getElementById('firstask').innerHTML='';

}

} else {

setTimeout(nomorepa, eval('' + delaymore));

delaymore=0;

}

}



function lastdivpop() {

var wasih='';

if (document.getElementById('lastdiv')) {

if (document.getElementById('lastdiv').innerHTML == '') {

wasih=wasih;

setTimeout(lastdivpop, 3000);

} else if (document.getElementById('lastdiv').innerHTML.indexOf('firstask') == -1) {

wasih=document.getElementById('lastdiv').innerHTML;

document.getElementById('lastdiv').innerHTML=prefixask + wasih;

prefixask='';

setTimeout(nomorepa, 20000);

} else {

setTimeout(lastdivpop, 3000);

}

}

}



setTimeout(lastdivpop, 8000);


Previous relevant Download and Copy or Move Server Tutorial is shown below.

Download and Copy or Move Server Tutorial

Download and Copy or Move Server Tutorial

Yesterdayโ€™s Download and Copy or Move Primer Tutorial was all about the โ€œclient sideโ€ of โ€ฆ

  • the โ€œserverโ€ side web applications/pages โ€ฆ and โ€ฆ
  • a โ€œclientโ€ side listener (like we talked about with Korn Shell listeners with Pandoc Document Conversion Email Tutorial)

โ€ฆ and weโ€™ve just โ€œtweakedโ€ (albeit, very importantly, in our books (โ€ฆ but the pamphlettes are still not playing ball)) to ensure no โ€œfile clobberingโ€ takes place so that the Korn Shell now does โ€ฆ



suf=""

isuf=-1

while [ -f "${dpath}/${brest}${suf}" ]; do

((isuf=isuf+1))

suf="_${isuf}"

done

if [ ! -z "$suf" ]; then

echo "mv ${dpath}/${brest} ${dpath}/${brest}${suf} # `date`" >> download_to_place.out

mv ${dpath}/${brest} ${dpath}/${brest}${suf} >> download_to_place.out 2>> download_to_place.err

fi

โ€ฆ in download_copierksh download_copierโšซksh Korn Shell scripting on our macOS operating system โ€œclientโ€.

But today is mainly about filling in the missing bits on the โ€œserverโ€ side. This (need for a) โ€œconduitโ€ we referred to yesterday is because we accept no folder paths can be mentioned at the โ€œserverโ€ end. Suppose, though, that the โ€œnon-pathedโ€ filename we supply to an โ€œaโ€ linkโ€™s โ€œdownloadโ€ attribute can be prefixed by a mildly mashed up version of that path we copy to from the Downloads folder of your โ€œclientโ€ computer or device, as you perform a โ€œdownloadโ€ via the clicking of an โ€œaโ€ link.

Well, at this blog weโ€™d already started functionality to toggle the use or not of โ€ฆ

  • โ€œaโ€ links โ€ฆ with โ€ฆ
  • โ€œhrefโ€ attribute containing โ€œGETMEโ€ โ€ฆ
  • but not โ€œdiff.phpโ€ โ€ฆ and โ€ฆ
  • โ€œdownloadโ€ attribute (the attribute necessary to โ€œdownloadโ€ rather than our default displaying of source code in a new webpage)

Were you here, then, when we published WordPress Blog Download Mode Toggler Primer Tutorial (or were you indisposed again?!) There we established an โ€œAll Postsโ€ menu โ€œToggle Download Mode from GETMEโ€ option piece of functionality to toggle between โ€ฆ

  • displaying of source code in a new webpage for GETME โ€œaโ€ links โ€ฆ versus โ€ฆ
  • use thechanged PHP toggle_downloadโšซphp in conjunction with a changed good โ€˜ol TwentyTen Theme header.php as below โ€ฆ
    <?php


    if (outs == null) {

    var dnprefix=decodeURIComponent(('' + localStorage.getItem('download_copy_to_folder')).replace(/^null$/g,'')).replace(/\+/g,' ').replace(/\\\\/g, '_').replace(/\//g, '_').replace(/\:/g, '_');

    for (idmjk=0; idmjk<admjk.length; idmjk++) {

    if (admjk[idmjk].href.indexOf('GETME') != -1 && admjk[idmjk].href.indexOf('diff.php') == -1) {



    if (origcafd < 0) { //!cafd) {

    xp=admjk[idmjk].href.split("GETME");

    prexp=xp[0].split("/");

    postprexp=prexp[-1 + prexp.length].split(".");

    extis = postprexp[-1 + postprexp.length].replace(/_/g,"").replace(/-/g,"").replace(/GETME/g,"");

    outs="//www.rjmprogramming.com.au/getmelist.htm?topoff=150&tsp=" + (Math.floor(Math.random() * 1999900) + 100) + "#" + postprexp[0] + "." + postprexp[-1 + postprexp.length].replace(extis,"").replace(extis,"").replace(extis,"") + "GETME" + extis;

    aorig=admjk[idmjk].innerHTML;

    admjk[idmjk].innerHTML=admjk[idmjk].innerHTML.replace(".","<span data-alt='" + outs + "' id='spn" + cafd + "' title=\" + Code Download Table\" onclick=\"if (cafd == cafd) { cafd=" + cafd + "; changeasfordownload(); } else { window.open('" + outs + "','_blank','top=100,left=100,width=500,height=500'); } return false; \">โšซ</span>");

    if (aorig == admjk[idmjk].innerHTML && admjk[idmjk].innerHTML.indexOf('er posts') == -1) admjk[idmjk].innerHTML=admjk[idmjk].innerHTML.replace(" ","<span data-alt='" + outs + "' id='spn" + cafd + "' title=\" + Code Download Table\" onclick=\"if (cafd == cafd) { cafd=" + cafd + "; changeasfordownload(); } else { window.open('" + outs + "','_blank','top=100,left=100,width=500,height=500'); } return false; \">โšช</span>");

    cafd++;

    } else {

    prestuffs = admjk[idmjk].href.split('/');

    newaspare = admjk[idmjk].href.replace('_-GETME', '').replace('__GETME', '').replace('_GETME', '').replace(big, '');



    while (big.indexOf('-') != -1) {



    big = big.replace('-', '');



    newaspare = newaspare.replace(big, '');



    }



    big = '----------------------GETME';

    stuffs = newaspare.split('/');

    if (dnprefix != '') {

    admjk[idmjk].download = dnprefix + prestuffs[stuffs.length - 1];

    } else {


    admjk[idmjk].download = dnprefix + stuffs[stuffs.length - 1];

    }

    admjk[idmjk].title = "(Really download) " + admjk[idmjk].title + ' ... welcome to the long hover functionality that shows allows for a Download Mode for the blog that can be toggled';

    admjk[idmjk].onmouseover = " getDownloadMode(); ";

    admjk[idmjk].onmouseout = " yehBut(); ";

    admjk[idmjk].ontouchstart = " getDownloadMode(); ";

    admjk[idmjk].ontouchend = " yehBut(); ";

    }

    } else if (admjk[idmjk].href.indexOf('GETME') != -1 && origcafd < 0) { //!cafd) {

    xp=admjk[idmjk].href.split("GETME");

    prexp=xp[0].split("/");

    postprexp=prexp[-1 + prexp.length].split(".");

    extis = postprexp[-1 + postprexp.length].replace(/_/g,"").replace(/-/g,"").replace(/GETME/g,"");

    outs="//www.rjmprogramming.com.au/getmelist.htm?topoff=150&tsp=" + (Math.floor(Math.random() * 1999900) + 100) + "#" + postprexp[0] + "." + postprexp[-1 + postprexp.length].replace(extis,"").replace(extis,"").replace(extis,"") + "GETME" + extis;

    aorig=admjk[idmjk].innerHTML;

    selbitis=allthecombos((admjk[idmjk].href + '=').split('=')[1].split('&')[0]);

    admjk[idmjk].innerHTML=admjk[idmjk].innerHTML.replace(".","<span data-alt='" + outs + "' id='spn" + cafd + "' title=\" + Code Download Table\" onclick=\"if (cafd == cafd) { cafd=" + cafd + "; changeasfordownload(); } else { window.open('" + outs + "','_blank','top=100,left=100,width=500,height=500'); } return false; \"><select onchange=\" if (this.value.length > 0) { window.open(this.value,'_blank'); } return false; \" style='margin-bottom:0px;width:40px;' id='sel" + cafd + "'><option value=>โšซ</option>" + selbitis + "</select></span>");

    if (aorig == admjk[idmjk].innerHTML && admjk[idmjk].innerHTML.indexOf('er posts') == -1) admjk[idmjk].innerHTML=admjk[idmjk].innerHTML.replace(" ","<span data-alt='" + outs + "' id='spn" + cafd + "' title=\" + Code Download Table\" onclick=\"if (cafd == cafd) { cafd=" + cafd + "; changeasfordownload(); } else { window.open('" + outs + "','_blank','top=100,left=100,width=500,height=500'); } return false; \"><select onchange=\" if (this.value.length > 0) { window.open(this.value,'_blank'); } return false; \" style='margin-bottom:0px;width:40px;' id='sel" + cafd + "'><option value=>โšช</option>" + selbitis + "</select></span>");

    cafd++;

    } else if ((admjk[idmjk].innerHTML.indexOf('live run') != -1 || admjk[idmjk].title.toLowerCase().indexOf('click picture') != -1) && origcafd < 0) { //!cafd) {

    outs="//www.rjmprogramming.com.au/slideshow.html#tuts";

    admjk[idmjk].innerHTML=admjk[idmjk].innerHTML.replace(" ","<span data-alt='" + outs + "' id='spn" + cafd + "' title=\" + Cut to the Chase ... see the blog post list related to live runs and slideshows ... ie. the main point of the blog posting\" onclick=\"if (cafd == cafd) { cafd=" + cafd + "; changeasfordownload(); } else { window.open('" + outs + "','_blank','top=100,left=100,width=650,height=100'); } return false; \">โœ‚</span>");

    cafd++;

    }

    }

    }


    ?>
    โ€ฆ to, depending on whether the user specifies in the โ€œAll Postsโ€ togglingโ€™s Javascript prompt window presented, specifies a new comma separated โ€œclient folder of interest to copy toโ€ place (stored in window.localStorage), will โ€ฆ

    1. download with the GETME to the Downloads folder and copy off to the specified folder of interest (backing up as necessary) โ€ฆ versus โ€ฆ
    2. the default download mode downloads to the Downloads folder without the GETME parts

See these changes in action below, contextualizing โ€œserverโ€ and โ€œclientโ€ codes in the full picture of assisted Downloads (copied on to a folder of the userโ€™s interest) โ€ฆ


Previous relevant Download and Copy or Move Primer Tutorial is shown below.

Download and Copy or Move Primer Tutorial

Download and Copy or Move Primer Tutorial

Downloading from โ€œthe netโ€ (โ€œserver landโ€) to your computer or device (โ€œclient landโ€) is a big part of the online experience and the sharing of data over the world wide web. But have you ever wondered about the two step design of โ€ฆ

  1. download from โ€œthe netโ€ to a Downloads folder on your computer or device โ€ฆ and more often than not โ€ฆ
  2. you, the user, copies or renames this data to another location on your computer or device with command line or with operating system GUI

โ€ฆ ? Why not allow the โ€œserverโ€ side define where it can download to on the โ€œclientโ€? Well, that would be a security nightmare, allowing a highjacking of mission critical files on your computer or device. So, I get it, that is a โ€œno noโ€. But could we have a controlled โ€œarrangementโ€ between โ€ฆ

  • the โ€œserverโ€ side web applications/pages โ€ฆ and โ€ฆ
  • a โ€œclientโ€ side listener (like we talked about with Korn Shell listeners with Pandoc Document Conversion Email Tutorial)

โ€ฆ ? We think that sounds reasonable and so, today, we start our (two parts or more) mini-project (making step 2 above be considered to be programmatically handled, sometimes) designing a Korn Shell (โ€œclientโ€ side) listener to suit our macOS โ€œclientโ€ computer, executed as a background process via โ€ฆ



ksh download_copierโšซksh &

But what is the conduit, if the โ€œserverโ€ web applications/pages cannot define a destination folder other than the macOS Downloads folder for the user involved? Well, that is where we need either โ€ฆ

โ€ฆ to define a โ€œclient landโ€ folder to copy to (from the userโ€™s Download folder (receiving the downloaded data).

That first Korn Shell read command interactive input was interesting to us for a command backgrounded via the โ€œ&โ€ command suffix. But if stdin and stdout are not mentioned in the command you can answer this interactive input and then the processing the Korn Shell performs proceeds in the background. Exactly what we were hoping for, but werenโ€™t sure that this was the case!

The picture is filled in better tomorrow as we discuss the conduit in more detail tomorrow.

If this was interesting you may be interested in this too.


If this was interesting you may be interested in this too.


If this was interesting you may be interested in this too.


If this was interesting you may be interested in this too.


If this was interesting you may be interested in this too.


If this was interesting you may be interested in this too.


If this was interesting you may be interested in this too.


If this was interesting you may be interested in this too.


If this was interesting you may be interested in this too.


If this was interesting you may be interested in this too.


If this was interesting you may be interested in this too.

This entry was posted in eLearning, Operating System, Tutorials and tagged , , , , , , , , , , . Bookmark the permalink.

Leave a Reply

Your email address will not be published. Required fields are marked *