etherpad-lite/node/handler/ImportHandler.js

/**
 * Handles the import requests
 */

/*
 * 2011 Peter 'Pita' Martischka (Primary Technology Ltd)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS-IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

var ERR = require("async-stacktrace");
var padManager = require("../db/PadManager");
var padMessageHandler = require("./PadMessageHandler");
var async = require("async");
var fs = require("fs");
var settings = require('../utils/Settings');
var formidable = require('formidable');
var os = require("os");

//load abiword only if its enabled
if(settings.abiword != null)
  var abiword = require("../utils/Abiword");

var tempDirectory = "/tmp/";

//tempDirectory changes if the operating system is windows
if(os.type().indexOf("Windows") > -1)
{
  tempDirectory = process.env.TEMP;
}
  
/**
 * do a requested import
 */ 
exports.doImport = function(req, res, padId)
{
  //pipe to a file
  //convert file to text via abiword
  //set text in the pad
  
  var srcFile, destFile;
  var pad;
  var text;
  
  async.series([
    //save the uploaded file to /tmp
    function(callback)
    {
      var form = new formidable.IncomingForm();
      form.keepExtensions = true;
      form.uploadDir = tempDirectory;
      
      form.parse(req, function(err, fields, files) 
      { 
        //the upload failed, stop at this point
        if(err || files.file === undefined)
        {
          console.warn("Uploading Error: " + err.stack);
          callback("uploadFailed");
        }
        //everything ok, continue
        else 
        {
          //save the path of the uploaded file
          srcFile = files.file.path;
          callback();
        }
      });
    },
    
    //ensure this is a file ending we know, else we change the file ending to .txt
    //this allows us to accept source code files like .c or .java
    function(callback)
    {
      var fileEnding = srcFile.split(".")[1].toLowerCase();
      var knownFileEndings = ["txt", "doc", "docx", "pdf", "odt", "html", "htm"];
      
      //find out if this is a known file ending
      var fileEndingKnown = false;
      for(var i in knownFileEndings)
      {
        if(fileEnding == knownFileEndings[i])
        {
          fileEndingKnown = true;
        }
      }
      
      //if the file ending is known, continue as normal
      if(fileEndingKnown)
      {
        callback();
      }
      //we need to rename this file with a .txt ending
      else
      {
        var oldSrcFile = srcFile;
        srcFile = srcFile.split(".")[0] + ".txt";
        
        fs.rename(oldSrcFile, srcFile, callback);
      }
    },
    
    //convert file to text
    function(callback)
    {
      var randNum = Math.floor(Math.random()*0xFFFFFFFF);
      destFile = tempDirectory + "eplite_import_" + randNum + ".txt";
      abiword.convertFile(srcFile, destFile, "txt", callback);
    },
    
    //get the pad object
    function(callback)
    {
      padManager.getPad(padId, function(err, _pad)
      {
        if(ERR(err, callback)) return;
        pad = _pad;
        callback();
      });
    },
    
    //read the text
    function(callback)
    {
      fs.readFile(destFile, "utf8", function(err, _text)
      {
        if(ERR(err, callback)) return;
        text = _text;
        
        //node on windows has a delay on releasing of the file lock.  
        //We add a 100ms delay to work around this
	      if(os.type().indexOf("Windows") > -1)
	      {
          setTimeout(function()
          {
            callback();
          }, 100);
	      }
	      else
	      {
	        callback();
	      }
      });
    },
    
    //change text of the pad and broadcast the changeset
    function(callback)
    {
      pad.setText(text);
      padMessageHandler.updatePadClients(pad, callback);
    },
    
    //clean up temporary files
    function(callback)
    {
      async.parallel([
        function(callback)
        {
          fs.unlink(srcFile, callback);
        },
        function(callback)
        {
          fs.unlink(destFile, callback);
        }
      ], callback);
    }
  ], function(err)
  {
    //the upload failed, there is nothing we can do, send a 500
    if(err == "uploadFailed")
    {
      res.send(500);
      return;
    }

    ERR(err);
  
    //close the connection
    res.send("ok");
  });
}