From 86791707cd12064a1e69abeedaacaf34e0db9d82 Mon Sep 17 00:00:00 2001
From: webzwo0i <webzwo0i@c3d2.de>
Date: Sun, 8 Dec 2013 11:31:23 +0100
Subject: [PATCH 01/11] fix export so no tags are omitted

---
 src/node/utils/ExportHtml.js | 23 +++++++----------------
 1 file changed, 7 insertions(+), 16 deletions(-)

diff --git a/src/node/utils/ExportHtml.js b/src/node/utils/ExportHtml.js
index 5179adf6..a58c4886 100644
--- a/src/node/utils/ExportHtml.js
+++ b/src/node/utils/ExportHtml.js
@@ -251,33 +251,24 @@ function getHTMLFromAtext(pad, atext, authorColors)
             propVals[i] = true; // set it back
           }
         }
+
         // now each member of propVal is in {false,LEAVE,ENTER,true}
-        // according to what happens at start of span
+        // false if not in this and not in previous, LEAVE if in previous, ENTER if new or true if
+        // in this and in the previous
+        // propChanged is true if any tag should be closed/opened
         if (propChanged)
         {
-          // leaving bold (e.g.) also leaves italics, etc.
-          var left = false;
           for (var i = 0; i < propVals.length; i++)
           {
             var v = propVals[i];
-            if (!left)
+            if (v === true && propVals.indexOf(LEAVE) != -1)
             {
-              if (v === LEAVE)
-              {
-                left = true;
-              }
-            }
-            else
-            {
-              if (v === true)
-              {
-                propVals[i] = STAY; // tag will be closed and re-opened
-              }
+              propVals[i] = STAY; // tag will be closed and re-opened
             }
           }
 
+          // close all tags that are open in previous op but not in this one
           var tags2close = [];
-
           for (var i = propVals.length - 1; i >= 0; i--)
           {
             if (propVals[i] === LEAVE)

From 70c51d731b045edcdfe16ed4bbbf48b427b36d92 Mon Sep 17 00:00:00 2001
From: webzwo0i <webzwo0i@c3d2.de>
Date: Sun, 8 Dec 2013 11:33:20 +0100
Subject: [PATCH 02/11] add some documentation for styling attributes export

---
 src/node/utils/ExportHtml.js | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/src/node/utils/ExportHtml.js b/src/node/utils/ExportHtml.js
index a58c4886..b5a03757 100644
--- a/src/node/utils/ExportHtml.js
+++ b/src/node/utils/ExportHtml.js
@@ -79,6 +79,10 @@ function getHTMLFromAtext(pad, atext, authorColors)
 
   var tags = ['h1', 'h2', 'strong', 'em', 'u', 's'];
   var props = ['heading1', 'heading2', 'bold', 'italic', 'underline', 'strikethrough'];
+  // holds a map of used styling attributes (*1, *2, etc) in the apool
+  // and maps them to an index in props
+  // *3:2 -> the attribute *3 means strong
+  // *2:5 -> the attribute *2 means s(trikethrough)
   var anumMap = {};
   var css = "";
 
@@ -113,10 +117,12 @@ function getHTMLFromAtext(pad, atext, authorColors)
              "}\n";
       }
     }
-    
+
     css+="</style>";
   }
 
+  // iterates over all props(h1,h2,strong,...), checks if it is used in
+  // this pad, and if yes puts its attrib id->props value into anumMap
   props.forEach(function (propName, i)
   {
     var propTrueNum = apool.putAttrib([propName, true], true);
@@ -128,7 +134,10 @@ function getHTMLFromAtext(pad, atext, authorColors)
 
   function getLineHTML(text, attribs)
   {
-    var propVals = [false, false, false];
+    // the current state of every attrib
+    // false if a tag was not seen or after it was pushed to tags2close
+    // true after emitOpenTag was called
+    var propVals = [false, false, false, false, false, false]; //every supported attrib
     var ENTER = 1;
     var STAY = 2;
     var LEAVE = 0;
@@ -188,7 +197,15 @@ function getHTMLFromAtext(pad, atext, authorColors)
         assem.append('>');
       }
     }
-    
+
+    // this function takes an array of tags that should be closed
+    // it iterates over the array of open tags and tags2close and if it 
+    // finds a match, it calls emitCloseTag (which removes and
+    // closes it) and decreases the iteration counter by one
+    // this ensures, that multiple tags can be closed:
+    //   opentags = ['strong','em','s']
+    //   closetags = ['s','em']
+    //
     function orderdCloseTags(tags2close)
     {
       for(var i=0;i<openTags.length;i++)
@@ -219,6 +236,8 @@ function getHTMLFromAtext(pad, atext, authorColors)
       var iter = Changeset.opIterator(Changeset.subattribution(attribs, idx, idx + numChars));
       idx += numChars;
 
+      // this iterates over every op string and decides which tags to open or to close
+      // based on the attribs used
       while (iter.hasNext())
       {
         var o = iter.next();

From a534b1ec2256afbd1ed13049b2b92f11e0dcce65 Mon Sep 17 00:00:00 2001
From: webzwo0i <webzwo0i@c3d2.de>
Date: Sun, 8 Dec 2013 11:34:11 +0100
Subject: [PATCH 03/11] some more docs for attribute export and cleanup empty
 lines

---
 src/node/utils/ExportHtml.js | 30 +++++++++++++++++-------------
 1 file changed, 17 insertions(+), 13 deletions(-)

diff --git a/src/node/utils/ExportHtml.js b/src/node/utils/ExportHtml.js
index b5a03757..53e27cc7 100644
--- a/src/node/utils/ExportHtml.js
+++ b/src/node/utils/ExportHtml.js
@@ -92,24 +92,24 @@ function getHTMLFromAtext(pad, atext, authorColors)
 
   if(authorColors){
     css+="<style>\n";
-    
+
     for (var a in apool.numToAttrib) {
       var attr = apool.numToAttrib[a];
-      
+
       //skip non author attributes
       if(attr[0] === "author" && attr[1] !== ""){
         //add to props array
         var propName = "author" + stripDotFromAuthorID(attr[1]);
         var newLength = props.push(propName);
         anumMap[a] = newLength -1;
-        
+
         css+="." + propName + " {background-color: " + authorColors[attr[1]]+ "}\n";
       } else if(attr[0] === "removed") {
         var propName = "removed";
-        
+
         var newLength = props.push(propName);
         anumMap[a] = newLength -1;
-        
+
         css+=".removed {text-decoration: line-through; " + 
              "-ms-filter:'progid:DXImageTransform.Microsoft.Alpha(Opacity=80)'; "+ 
              "filter: alpha(opacity=80); "+
@@ -154,25 +154,27 @@ function getHTMLFromAtext(pad, atext, authorColors)
     function getSpanClassFor(i){
       //return if author colors are disabled
       if (!authorColors) return false;
-      
+
       var property = props[i];
-   
+
       if(property.substr(0,6) === "author"){
         return stripDotFromAuthorID(property);
       }
-      
+
       if(property === "removed"){
         return "removed";
       }
-      
+
       return false;
     }
 
+    // is called when an attribute is in ENTER or STAY state and saves
+    // a reference to it so it can be closed in order
     function emitOpenTag(i)
     {
       openTags.unshift(i);
       var spanClass = getSpanClassFor(i);
-      
+
       if(spanClass){
         assem.append('<span class="');
         assem.append(spanClass);
@@ -184,11 +186,13 @@ function getHTMLFromAtext(pad, atext, authorColors)
       }
     }
 
+    // this closes an open tag and removes its reference from openTags
+    // it is not directly called but via orderdCloseTags
     function emitCloseTag(i)
     {
       openTags.shift();
       var spanClass = getSpanClassFor(i);
-      
+
       if(spanClass){
         assem.append('</span>');
       } else {
@@ -339,7 +343,7 @@ function getHTMLFromAtext(pad, atext, authorColors)
           propVals[i] = false;
         }
       }
-      
+
       orderdCloseTags(tags2close);
     } // end processNextChars
     if (urls)
@@ -373,7 +377,7 @@ function getHTMLFromAtext(pad, atext, authorColors)
   {
     var line = _analyzeLine(textLines[i], attribLines[i], apool);
     var lineContent = getLineHTML(line.text, line.aline);
-            
+
     if (line.listLevel)//If we are inside a list
     {
       // do list stuff

From 656a558af987c85e173a6e51f2ec11980ff24ec2 Mon Sep 17 00:00:00 2001
From: webzwo0i <webzwo0i@c3d2.de>
Date: Sun, 8 Dec 2013 11:35:28 +0100
Subject: [PATCH 04/11] be more clear about the value in propVals

---
 src/node/utils/ExportHtml.js | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/src/node/utils/ExportHtml.js b/src/node/utils/ExportHtml.js
index 53e27cc7..b445967e 100644
--- a/src/node/utils/ExportHtml.js
+++ b/src/node/utils/ExportHtml.js
@@ -251,17 +251,23 @@ function getHTMLFromAtext(pad, atext, authorColors)
           if (a in anumMap)
           {
             var i = anumMap[a]; // i = 0 => bold, etc.
+
+            //true branch: if false or undefined or LEAVE set ENTER and propChanged
+            //false branch: if its true (the tag was opened in one of previous op) set it STAY
             if (!propVals[i])
             {
               propVals[i] = ENTER;
               propChanged = true;
             }
-            else
+            else if(propVals[i] === true)
             {
               propVals[i] = STAY;
             }
           }
-        });
+        }); // now all attribs of this op have been parsed
+
+        // if an attrib is no longer used in this op but was used in the previous set it to LEAVE
+        // otherwise if its STAY(was previously open and still is) set it true
         for (var i = 0; i < propVals.length; i++)
         {
           if (propVals[i] === true)

From 51769585a94fbc25f13a22fd52739112bd8f2970 Mon Sep 17 00:00:00 2001
From: webzwo0i <webzwo0i@c3d2.de>
Date: Sun, 8 Dec 2013 11:37:07 +0100
Subject: [PATCH 05/11] workaround so that at least one tag stays open if its
 the outermost tag. saves some space in the output

---
 src/node/utils/ExportHtml.js | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/src/node/utils/ExportHtml.js b/src/node/utils/ExportHtml.js
index b445967e..2a614e99 100644
--- a/src/node/utils/ExportHtml.js
+++ b/src/node/utils/ExportHtml.js
@@ -306,18 +306,20 @@ function getHTMLFromAtext(pad, atext, authorColors)
               tags2close.push(i);
               propVals[i] = false;
             }
-            else if (propVals[i] === STAY)
+            else if (propVals[i] === STAY && openTags[openTags.length - 1] != i)
             {
               //emitCloseTag(i);
               tags2close.push(i);
             }
           }
-          
           orderdCloseTags(tags2close);
-          
+
+          // open all tags that are used in this op or got closed to satisfy order
+          // e.g. <em><s><u>em&strikethrough&underline</u>strikethrough&em</s></em><s>strikethrough</s>
+          // TODO?: ensure the best ie shortest resolution
           for (var i = 0; i < propVals.length; i++)
           {
-            if (propVals[i] === ENTER || propVals[i] === STAY)
+            if (propVals[i] === ENTER || (propVals[i] === STAY && openTags[openTags.length - 1] != i))
             {
               emitOpenTag(i);
               propVals[i] = true;

From f968b5a057bebf3223a063f356344ef2404f5255 Mon Sep 17 00:00:00 2001
From: webzwo0i <webzwo0i@c3d2.de>
Date: Sun, 8 Dec 2013 11:37:47 +0100
Subject: [PATCH 06/11] useless var statement (function scope)

---
 src/node/utils/ExportHtml.js | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/src/node/utils/ExportHtml.js b/src/node/utils/ExportHtml.js
index 2a614e99..51d635d5 100644
--- a/src/node/utils/ExportHtml.js
+++ b/src/node/utils/ExportHtml.js
@@ -332,17 +332,18 @@ function getHTMLFromAtext(pad, atext, authorColors)
         {
           chars--; // exclude newline at end of line, if present
         }
-        
+
         var s = taker.take(chars);
-        
+
         //removes the characters with the code 12. Don't know where they come 
         //from but they break the abiword parser and are completly useless
         s = s.replace(String.fromCharCode(12), "");
-        
+
         assem.append(_encodeWhitespace(Security.escapeHTML(s)));
       } // end iteration over spans in line
-      
-      var tags2close = [];
+
+      // close all the tags that are open after the last op
+      tags2close = [];
       for (var i = propVals.length - 1; i >= 0; i--)
       {
         if (propVals[i])

From 27e0c377791b5ce5d999840875d70a5a098fa566 Mon Sep 17 00:00:00 2001
From: webzwo0i <webzwo0i@c3d2.de>
Date: Sun, 8 Dec 2013 13:39:50 +0100
Subject: [PATCH 07/11] refactor export of style attributes 1. mark all
 attributes that are used 2. find the outermost attribute that is no longer
 used 3. close all tags upto this attribute 4. open all tags that are used and
 not open (5. close all open tags)

---
 src/node/utils/ExportHtml.js | 97 +++++++++---------------------------
 1 file changed, 24 insertions(+), 73 deletions(-)

diff --git a/src/node/utils/ExportHtml.js b/src/node/utils/ExportHtml.js
index 51d635d5..9d064f6d 100644
--- a/src/node/utils/ExportHtml.js
+++ b/src/node/utils/ExportHtml.js
@@ -246,87 +246,45 @@ function getHTMLFromAtext(pad, atext, authorColors)
       {
         var o = iter.next();
         var propChanged = false;
+        var usedAttribs = [];
+
+        // mark all attribs as used
         Changeset.eachAttribNumber(o.attribs, function (a)
         {
           if (a in anumMap)
           {
-            var i = anumMap[a]; // i = 0 => bold, etc.
-
-            //true branch: if false or undefined or LEAVE set ENTER and propChanged
-            //false branch: if its true (the tag was opened in one of previous op) set it STAY
-            if (!propVals[i])
-            {
-              propVals[i] = ENTER;
-              propChanged = true;
-            }
-            else if(propVals[i] === true)
-            {
-              propVals[i] = STAY;
-            }
+            usedAttribs.push(anumMap[a]); // i = 0 => bold, etc.
           }
-        }); // now all attribs of this op have been parsed
-
-        // if an attrib is no longer used in this op but was used in the previous set it to LEAVE
-        // otherwise if its STAY(was previously open and still is) set it true
-        for (var i = 0; i < propVals.length; i++)
+        });
+        var outermostTag = -1;
+        // find the outer most open tag that is no longer used
+        for (var i = openTags.length - 1; i >= 0; i--)
         {
-          if (propVals[i] === true)
+          if (usedAttribs.indexOf(openTags[i]) === -1)
           {
-            propVals[i] = LEAVE;
-            propChanged = true;
-          }
-          else if (propVals[i] === STAY)
-          {
-            propVals[i] = true; // set it back
+            outermostTag = i;
+            break;
           }
         }
 
-        // now each member of propVal is in {false,LEAVE,ENTER,true}
-        // false if not in this and not in previous, LEAVE if in previous, ENTER if new or true if
-        // in this and in the previous
-        // propChanged is true if any tag should be closed/opened
-        if (propChanged)
+        // close all tags upto the outer most
+        if (outermostTag != -1)
         {
-          for (var i = 0; i < propVals.length; i++)
+          for (var i=0; i <= outermostTag; outermostTag--)
           {
-            var v = propVals[i];
-            if (v === true && propVals.indexOf(LEAVE) != -1)
-            {
-              propVals[i] = STAY; // tag will be closed and re-opened
-            }
+            emitCloseTag(openTags[0])
           }
+        }
 
-          // close all tags that are open in previous op but not in this one
-          var tags2close = [];
-          for (var i = propVals.length - 1; i >= 0; i--)
+        // open all tags that are used but not open
+        for (var i=0; i < usedAttribs.length; i++)
+        {
+          if (openTags.indexOf(usedAttribs[i]) === -1)
           {
-            if (propVals[i] === LEAVE)
-            {
-              //emitCloseTag(i);
-              tags2close.push(i);
-              propVals[i] = false;
-            }
-            else if (propVals[i] === STAY && openTags[openTags.length - 1] != i)
-            {
-              //emitCloseTag(i);
-              tags2close.push(i);
-            }
+            emitOpenTag(usedAttribs[i])
           }
-          orderdCloseTags(tags2close);
+        }
 
-          // open all tags that are used in this op or got closed to satisfy order
-          // e.g. <em><s><u>em&strikethrough&underline</u>strikethrough&em</s></em><s>strikethrough</s>
-          // TODO?: ensure the best ie shortest resolution
-          for (var i = 0; i < propVals.length; i++)
-          {
-            if (propVals[i] === ENTER || (propVals[i] === STAY && openTags[openTags.length - 1] != i))
-            {
-              emitOpenTag(i);
-              propVals[i] = true;
-            }
-          }
-          // propVals is now all {true,false} again
-        } // end if (propChanged)
         var chars = o.chars;
         if (o.lines)
         {
@@ -343,17 +301,10 @@ function getHTMLFromAtext(pad, atext, authorColors)
       } // end iteration over spans in line
 
       // close all the tags that are open after the last op
-      tags2close = [];
-      for (var i = propVals.length - 1; i >= 0; i--)
+      while (openTags.length > 0)
       {
-        if (propVals[i])
-        {
-          tags2close.push(i);
-          propVals[i] = false;
-        }
+        emitCloseTag(openTags[0])
       }
-
-      orderdCloseTags(tags2close);
     } // end processNextChars
     if (urls)
     {

From 0fa0d6dc2cb0ab89c7aab10d4d2c9ab6a162f775 Mon Sep 17 00:00:00 2001
From: webzwo0i <webzwo0i@c3d2.de>
Date: Sun, 8 Dec 2013 13:45:45 +0100
Subject: [PATCH 08/11] remove now unused code

---
 src/node/utils/ExportHtml.js | 36 ------------------------------------
 1 file changed, 36 deletions(-)

diff --git a/src/node/utils/ExportHtml.js b/src/node/utils/ExportHtml.js
index 9d064f6d..16b3d7b2 100644
--- a/src/node/utils/ExportHtml.js
+++ b/src/node/utils/ExportHtml.js
@@ -134,14 +134,6 @@ function getHTMLFromAtext(pad, atext, authorColors)
 
   function getLineHTML(text, attribs)
   {
-    // the current state of every attrib
-    // false if a tag was not seen or after it was pushed to tags2close
-    // true after emitOpenTag was called
-    var propVals = [false, false, false, false, false, false]; //every supported attrib
-    var ENTER = 1;
-    var STAY = 2;
-    var LEAVE = 0;
-
     // Use order of tags (b/i/u) as order of nesting, for simplicity
     // and decent nesting.  For example,
     // <b>Just bold<b> <b><i>Bold and italics</i></b> <i>Just italics</i>
@@ -168,8 +160,6 @@ function getHTMLFromAtext(pad, atext, authorColors)
       return false;
     }
 
-    // is called when an attribute is in ENTER or STAY state and saves
-    // a reference to it so it can be closed in order
     function emitOpenTag(i)
     {
       openTags.unshift(i);
@@ -187,7 +177,6 @@ function getHTMLFromAtext(pad, atext, authorColors)
     }
 
     // this closes an open tag and removes its reference from openTags
-    // it is not directly called but via orderdCloseTags
     function emitCloseTag(i)
     {
       openTags.shift();
@@ -202,30 +191,6 @@ function getHTMLFromAtext(pad, atext, authorColors)
       }
     }
 
-    // this function takes an array of tags that should be closed
-    // it iterates over the array of open tags and tags2close and if it 
-    // finds a match, it calls emitCloseTag (which removes and
-    // closes it) and decreases the iteration counter by one
-    // this ensures, that multiple tags can be closed:
-    //   opentags = ['strong','em','s']
-    //   closetags = ['s','em']
-    //
-    function orderdCloseTags(tags2close)
-    {
-      for(var i=0;i<openTags.length;i++)
-      {
-        for(var j=0;j<tags2close.length;j++)
-        {
-          if(tags2close[j] == openTags[i])
-          {
-            emitCloseTag(tags2close[j]);
-            i--;
-            break;
-          }
-        }
-      }
-    }
-
     var urls = _findURLs(text);
 
     var idx = 0;
@@ -245,7 +210,6 @@ function getHTMLFromAtext(pad, atext, authorColors)
       while (iter.hasNext())
       {
         var o = iter.next();
-        var propChanged = false;
         var usedAttribs = [];
 
         // mark all attribs as used

From c3081c046b5e243007bf994ccd195c26697c0f9f Mon Sep 17 00:00:00 2001
From: webzwo0i <webzwo0i@c3d2.de>
Date: Sun, 8 Dec 2013 13:47:05 +0100
Subject: [PATCH 09/11] function scope: variables only need to be declared once

---
 src/node/utils/ExportHtml.js | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/node/utils/ExportHtml.js b/src/node/utils/ExportHtml.js
index 16b3d7b2..433ac900 100644
--- a/src/node/utils/ExportHtml.js
+++ b/src/node/utils/ExportHtml.js
@@ -234,14 +234,14 @@ function getHTMLFromAtext(pad, atext, authorColors)
         // close all tags upto the outer most
         if (outermostTag != -1)
         {
-          for (var i=0; i <= outermostTag; outermostTag--)
+          for (i=0; i <= outermostTag; outermostTag--)
           {
             emitCloseTag(openTags[0])
           }
         }
 
         // open all tags that are used but not open
-        for (var i=0; i < usedAttribs.length; i++)
+        for (i=0; i < usedAttribs.length; i++)
         {
           if (openTags.indexOf(usedAttribs[i]) === -1)
           {
@@ -511,8 +511,8 @@ function _processSpaces(s){
       }
     }
     // beginning of line is nbsp
-    for (var i = 0; i < parts.length; i++){
-      var p = parts[i];
+    for (i = 0; i < parts.length; i++){
+      p = parts[i];
       if (p == " "){
         parts[i] = '&nbsp;';
         break;
@@ -524,8 +524,8 @@ function _processSpaces(s){
   }
   else
   {
-    for (var i = 0; i < parts.length; i++){
-      var p = parts[i];
+    for (i = 0; i < parts.length; i++){
+      p = parts[i];
       if (p == " "){
         parts[i] = '&nbsp;';
       }

From 9557dc9dba04d14d4fc3d1d9d3d0da75d8872441 Mon Sep 17 00:00:00 2001
From: webzwo0i <webzwo0i@c3d2.de>
Date: Sun, 8 Dec 2013 13:48:21 +0100
Subject: [PATCH 10/11] remove unused require

---
 src/node/utils/ExportHtml.js | 1 -
 1 file changed, 1 deletion(-)

diff --git a/src/node/utils/ExportHtml.js b/src/node/utils/ExportHtml.js
index 433ac900..e50c4bae 100644
--- a/src/node/utils/ExportHtml.js
+++ b/src/node/utils/ExportHtml.js
@@ -21,7 +21,6 @@ var padManager = require("../db/PadManager");
 var ERR = require("async-stacktrace");
 var Security = require('ep_etherpad-lite/static/js/security');
 var hooks = require('ep_etherpad-lite/static/js/pluginfw/hooks');
-var getPadPlainText = require('./ExportHelper').getPadPlainText;
 var _analyzeLine = require('./ExportHelper')._analyzeLine;
 var _encodeWhitespace = require('./ExportHelper')._encodeWhitespace;
 

From e1fbb1d1aa56b058e836a4eb24cd8aa62045f691 Mon Sep 17 00:00:00 2001
From: webzwo0i <webzwo0i@c3d2.de>
Date: Sun, 8 Dec 2013 13:53:26 +0100
Subject: [PATCH 11/11] fix loop

---
 src/node/utils/ExportHtml.js | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/node/utils/ExportHtml.js b/src/node/utils/ExportHtml.js
index e50c4bae..01920da7 100644
--- a/src/node/utils/ExportHtml.js
+++ b/src/node/utils/ExportHtml.js
@@ -233,9 +233,10 @@ function getHTMLFromAtext(pad, atext, authorColors)
         // close all tags upto the outer most
         if (outermostTag != -1)
         {
-          for (i=0; i <= outermostTag; outermostTag--)
+          while ( outermostTag >= 0 )
           {
-            emitCloseTag(openTags[0])
+            emitCloseTag(openTags[0]);
+            outermostTag--;
           }
         }