diff --git a/README.md b/README.md index 3d5ff1466..c752fe999 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # About Etherpad lite is a really-real time collaborative editor spawned from the Hell fire of Etherpad. We're reusing the well tested Etherpad easysync library to make it really realtime. Etherpad Lite -is based on node.js what makes it much ligther and more stable than the original Etherpad. Our hope +is based on node.js what makes it much lighter and more stable than the original Etherpad. Our hope is that this will encourage more users to install a realtime collaborative editor. A smaller and well documented codebase makes it easier for developers to improve the code. Etherpad Lite is optimized to be easy embeddable. Look at our [FAQ Page](https://github.com/Pita/etherpad-lite/wiki/FAQ) @@ -32,7 +32,7 @@ Visit to test it live.
You can find the same ins **As root:**
    -
  1. Install all dependencies. We need the sqlite develob libraries, gzip, git, curl, libssl develop libraries and python
    apt-get install libsqlite3-dev gzip git-core curl python libssl-dev

    2. +
  2. Install all dependencies. We need the sqlite development libraries, gzip, git, curl, libssl develop libraries and python
    apt-get install libsqlite3-dev gzip git-core curl python libssl-dev

  3. Install node.js
    1. Download the latest 0.4.x node.js release from http://nodejs.org/#download
      2. @@ -43,7 +43,7 @@ Visit to test it live.
      You can find the same ins
    2. Install npm curl http://npmjs.org/install.sh | sh
    -**As any user (we recommend creating a seperate user called etherpad-lite):** +**As any user (we recommend creating a separate user called etherpad-lite):**
    1. Clone the git repository git clone 'git://github.com/Pita/etherpad-lite.git'
       
      2. @@ -55,7 +55,7 @@ Visit to test it live.
      You can find the same ins ## Troubleshooting ### It fails while installing the sqlite dependency -The sqlite package of some linux versions (including debian lenny) is too old. We need sqlite >=3.6. You have to use a PPA or debian backports. You find sqlite packages for Ubuntu Hardy [here](https://launchpad.net/~mirabilos/+archive/ppa/+sourcepub/1304941/+listing-archive-extra), Debian Backports can be found [here](http://backports-master.debian.org/Instructions/#index1h2) +The sqlite package of some Linux versions (including debian lenny) is too old. We need sqlite >=3.6. You have to use a PPA or debian backports. You find sqlite packages for Ubuntu Hardy [here](https://launchpad.net/~mirabilos/+archive/ppa/+sourcepub/1304941/+listing-archive-extra), Debian Backports can be found [here](http://backports-master.debian.org/Instructions/#index1h2) ### It fails while installing the express dependency, it says my node version is wrong You might have installed node.js version 0.5. You can check that with `node --version`. Please reinstall node 0.4.x @@ -93,7 +93,7 @@ You also help the project, if you only host a Etherpad Lite instance and share y # Modules created for this project * [ueberDB](https://github.com/Pita/ueberDB) "transforms every database into a object key value store" - manages all database access -* [doc.md](https://github.com/Pita/doc.md) "A simple JSDoc documenation tool that creates markdown for node.js modules exports" - is used to generate the docs +* [doc.md](https://github.com/Pita/doc.md) "A simple JSDoc documentation tool that creates markdown for node.js modules exports" - is used to generate the docs * [channels](https://github.com/Pita/channels) "Event channels in node.js" - ensures that ueberDB operations are atomic and in series for each key # License diff --git a/node/utils/ExportHtml.js b/node/utils/ExportHtml.js index e74e404ca..dce156ec8 100644 --- a/node/utils/ExportHtml.js +++ b/node/utils/ExportHtml.js @@ -13,27 +13,30 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + var async = require("async"); var Changeset = require("./Changeset"); var padManager = require("../db/PadManager"); - -function getPadPlainText(pad, revNum) { - var atext = ((revNum !== undefined) ? pad.getInternalRevisionAText(revNum) : - pad.atext()); - var textLines = atext.text.slice(0,-1).split('\n'); +function getPadPlainText(pad, revNum) +{ + var atext = ((revNum !== undefined) ? pad.getInternalRevisionAText(revNum) : pad.atext()); + var textLines = atext.text.slice(0, -1).split('\n'); var attribLines = Changeset.splitAttributionLines(atext.attribs, atext.text); var apool = pad.pool(); var pieces = []; - for(var i=0;i= 0) { + + props.forEach(function (propName, i) + { + var propTrueNum = apool.putAttrib([propName, true], true); + if (propTrueNum >= 0) + { anumMap[propTrueNum] = i; } }); - function getLineHTML(text, attribs) { + function getLineHTML(text, attribs) + { var propVals = [false, false, false]; var ENTER = 1; var STAY = 2; @@ -97,16 +116,18 @@ function getHTMLFromAtext(pad, atext) { // Just bold Bold and italics Just italics // becomes // Just bold Bold and italics Just italics - var taker = Changeset.stringIterator(text); var assem = Changeset.stringAssembler(); - function emitOpenTag(i) { + function emitOpenTag(i) + { assem.append('<'); assem.append(tags[i]); assem.append('>'); } - function emitCloseTag(i) { + + function emitCloseTag(i) + { assem.append(''); @@ -115,101 +136,123 @@ function getHTMLFromAtext(pad, atext) { var urls = _findURLs(text); var idx = 0; - function processNextChars(numChars) { - if (numChars <= 0) { + + function processNextChars(numChars) + { + if (numChars <= 0) + { return; } - var iter = Changeset.opIterator(Changeset.subattribution(attribs, - idx, idx+numChars)); + var iter = Changeset.opIterator(Changeset.subattribution(attribs, idx, idx + numChars)); idx += numChars; - while (iter.hasNext()) { + while (iter.hasNext()) + { var o = iter.next(); var propChanged = false; - Changeset.eachAttribNumber(o.attribs, function(a) { - if (a in anumMap) { + Changeset.eachAttribNumber(o.attribs, function (a) + { + if (a in anumMap) + { var i = anumMap[a]; // i = 0 => bold, etc. - if (! propVals[i]) { + if (!propVals[i]) + { propVals[i] = ENTER; propChanged = true; } - else { + else + { propVals[i] = STAY; } } }); - for(var i=0;i=0; i--) { - if (propVals[i] === LEAVE) { + for (var i = propVals.length - 1; i >= 0; i--) + { + if (propVals[i] === LEAVE) + { emitCloseTag(i); propVals[i] = false; } - else if (propVals[i] === STAY) { + else if (propVals[i] === STAY) + { emitCloseTag(i); } } - for(var i=0; i=0; i--) { - if (propVals[i]) { + for (var i = propVals.length - 1; i >= 0; i--) + { + if (propVals[i]) + { emitCloseTag(i); propVals[i] = false; } } } // end processNextChars - - if (urls) { - urls.forEach(function(urlData) { + if (urls) + { + urls.forEach(function (urlData) + { var startIndex = urlData[0]; var url = urlData[1]; var urlLength = url.length; processNextChars(startIndex - idx); - assem.append(''); + assem.append(''); processNextChars(urlLength); assem.append(''); }); @@ -218,7 +261,6 @@ function getHTMLFromAtext(pad, atext) { return _processSpaces(assem.toString()); } // end getLineHTML - var pieces = []; // Need to deal with constraints imposed on HTML lists; can @@ -228,79 +270,98 @@ function getHTMLFromAtext(pad, atext) { // so we want to do something reasonable there. We also // want to deal gracefully with blank lines. var lists = []; // e.g. [[1,'bullet'], [3,'bullet'], ...] - for(var i=0;i 0) { + if (line.listLevel || lists.length > 0) + { // do list stuff var whichList = -1; // index into lists or -1 - if (line.listLevel) { + if (line.listLevel) + { whichList = lists.length; - for(var j=lists.length-1;j>=0;j--) { - if (line.listLevel <= lists[j][0]) { + for (var j = lists.length - 1; j >= 0; j--) + { + if (line.listLevel <= lists[j][0]) + { whichList = j; } } } - if (whichList >= lists.length) { + if (whichList >= lists.length) + { lists.push([line.listLevel, line.listTypeName]); pieces.push('
      • ', lineContent || '
        '); } - else if (whichList == -1) { - if (line.text) { + else if (whichList == -1) + { + if (line.text) + { // non-blank line, end all lists - pieces.push(new Array(lists.length+1).join('
        • ')); + pieces.push(new Array(lists.length + 1).join('')); lists.length = 0; pieces.push(lineContent, '
        '); } - else { + else + { pieces.push('

        '); } } - else { - while (whichList < lists.length-1) { + else + { + while (whichList < lists.length - 1) + { pieces.push('
      '); lists.length--; } pieces.push('
    2. ', lineContent || '
      '); } } - else { + else + { pieces.push(lineContent, '
      '); } } - pieces.push(new Array(lists.length+1).join('
      3. ')); + pieces.push(new Array(lists.length + 1).join('')); return pieces.join(''); } -function _analyzeLine(text, aline, apool) { +function _analyzeLine(text, aline, apool) +{ var line = {}; // identify list var lineMarker = 0; line.listLevel = 0; - if (aline) { + if (aline) + { var opIter = Changeset.opIterator(aline); - if (opIter.hasNext()) { + if (opIter.hasNext()) + { var listType = Changeset.opAttributeValue(opIter.next(), 'list', apool); - if (listType) { + if (listType) + { lineMarker = 1; listType = /([a-z]+)([12345678])/.exec(listType); - if (listType) { + if (listType) + { line.listTypeName = listType[1]; line.listLevel = Number(listType[2]); } } } } - if (lineMarker) { + if (lineMarker) + { line.text = text.substring(1); line.aline = Changeset.subattribution(aline, 1); } - else { + else + { line.text = text; line.aline = aline; } @@ -308,37 +369,32 @@ function _analyzeLine(text, aline, apool) { return line; } -exports.getPadHTMLDocument = function(padId, revNum, noDocType, callback) { - padManager.getPad(padId, function(err, pad) +exports.getPadHTMLDocument = function (padId, revNum, noDocType, callback) +{ + padManager.getPad(padId, function (err, pad) { - if(err) + if (err) { callback(err); return; } - - var head = (noDocType?'':'\n')+ - '\n'+ - (noDocType?'': - '\n'+ - '\n'+ - '\n' + - '\n')+ - ''; + + var head = (noDocType ? '' : '\n') + '\n' + (noDocType ? '' : '\n' + '\n' + '\n' + '\n') + ''; var foot = '\n\n'; - getPadHTML(pad, revNum, function (err, html) { + getPadHTML(pad, revNum, function (err, html) + { callback(err, head + html + foot); }); }); } -function _escapeHTML(s) { +function _escapeHTML(s) +{ var re = /[&<>]/g; - if (! re.MAP) { + if (!re.MAP) + { // persisted across function calls! re.MAP = { '&': '&', @@ -346,53 +402,78 @@ function _escapeHTML(s) { '>': '>', }; } - return s.replace(re, function(c) { return re.MAP[c]; }); + + s = s.replace(re, function (c) + { + return re.MAP[c]; + }); + + return s.replace(/[^\x21-\x7E\s\t\n\r]/g, function(c) + { + return "&#" +c.charCodeAt(0) + ";" + }); } // copied from ACE -function _processSpaces(s) { + + +function _processSpaces(s) +{ var doesWrap = true; - if (s.indexOf("<") < 0 && ! doesWrap) { + if (s.indexOf("<") < 0 && !doesWrap) + { // short-cut return s.replace(/ /g, ' '); } var parts = []; - s.replace(/<[^>]*>?| |[^ <]+/g, function(m) { parts.push(m); }); - if (doesWrap) { + s.replace(/<[^>]*>?| |[^ <]+/g, function (m) + { + parts.push(m); + }); + if (doesWrap) + { var endOfLine = true; var beforeSpace = false; // last space in a run is normal, others are nbsp, // end of line is nbsp - for(var i=parts.length-1;i>=0;i--) { + for (var i = parts.length - 1; i >= 0; i--) + { var p = parts[i]; - if (p == " ") { - if (endOfLine || beforeSpace) - parts[i] = ' '; - endOfLine = false; - beforeSpace = true; + if (p == " ") + { + if (endOfLine || beforeSpace) parts[i] = ' '; + endOfLine = false; + beforeSpace = true; } - else if (p.charAt(0) != "<") { - endOfLine = false; - beforeSpace = false; + else if (p.charAt(0) != "<") + { + endOfLine = false; + beforeSpace = false; } } // beginning of line is nbsp - for(var i=0;i
    3. - +
    4. - - - + +
      +
    5. - +
    6. - - - + +
      +
    8. - +
    9. - +
    10. - - + +
    12. - - - + +
      +
    13. - - +
      +
    15. - - - + +
      +
      16. @@ -256,13 +250,13 @@ Use this link to share a read-only version of your pad: Chat - +
      0
      -
      Chatx 
      +
      Chat- 
      @@ -271,10 +265,13 @@ Use this link to share a read-only version of your pad:
      +
       
      +
      +