Merge pull request #2150 from ether/export-file-name-hook

Server side hook to modify the export file name

doc/api/hooks_server-side.md

@@ -247,3 +247,19 @@ Things in context:
 
 This hook will allow a plug-in developer to re-write each line when exporting to HTML.
 
+## exportFileName
+Called from src/node/handler/ExportHandler.js 
+
+Things in context:
+
+1. padId
+
+This hook will allow a plug-in developer to modify the file name of an exported pad.  This is useful if you want to export a pad under another name and/or hide the padId under export.  Note that the doctype or file extension cannot be modified for security reasons.
+
+Example:
+
+```
+exports.exportFileName = function(hook, padId, callback){
+  callback("newFileName"+padId);
+}
+```

src/node/handler/ExportHandler.js

@@ -27,6 +27,7 @@ var async = require("async");
 var fs = require("fs");
 var settings = require('../utils/Settings');
 var os = require('os');
+var hooks = require("ep_etherpad-lite/static/js/pluginfw/hooks");
 
 //load abiword only if its enabled
 if(settings.abiword != null)
@@ -45,8 +46,17 @@ if(os.type().indexOf("Windows") > -1)
  */ 
 exports.doExport = function(req, res, padId, type)
 {
+  var fileName = padId;
+
+  // allow fileName to be overwritten by a hook, the type type is kept static for security reasons
+  hooks.aCallFirst("exportFileName", padId, 
+    function(err, hookFileName){
+      // if fileName is set then set it to the padId, note that fileName is returned as an array.
+      if(hookFileName) fileName = hookFileName; 
+
+
       //tell the browser that this is a downloadable file
-  res.attachment(padId + "." + type);
+      res.attachment(fileName + "." + type);
     
       //if this is a plain text export, we can do this directly
       // We have to over engineer this because tabs are stored as attributes and not plain text
@@ -81,7 +91,7 @@ exports.doExport = function(req, res, padId, type)
             //ensure html can be collected by the garbage collector
             txt = null;
     
-        destFile = tempDirectory + "/eplite_export_" + randNum + "." + type;
+            destFile = tempDirectory + "/etherpad_export_" + randNum + "." + type;
             abiword.convertFile(srcFile, destFile, type, callback);
           },
           //send the file
@@ -168,7 +178,7 @@ exports.doExport = function(req, res, padId, type)
             else //write the html export to a file
             {
               randNum = Math.floor(Math.random()*0xFFFFFFFF);
-          srcFile = tempDirectory + "/eplite_export_" + randNum + ".html";
+              srcFile = tempDirectory + "/etherpad_export_" + randNum + ".html";
               fs.writeFile(srcFile, html, callback); 
             }
           },
@@ -178,7 +188,7 @@ exports.doExport = function(req, res, padId, type)
             //ensure html can be collected by the garbage collector
             html = null;
           
-        destFile = tempDirectory + "/eplite_export_" + randNum + "." + type;
+            destFile = tempDirectory + "/etherpad_export_" + randNum + "." + type;
             abiword.convertFile(srcFile, destFile, type, callback);
           },
           //send the file
@@ -216,4 +226,6 @@ exports.doExport = function(req, res, padId, type)
           if(err && err != "stop") ERR(err);
         })
       }
+    }
+  );
 };

src/node/handler/ImportHandler.js

@@ -98,7 +98,7 @@ exports.doImport = function(req, res, padId)
       }
     },
     function(callback){
-      destFile = path.join(tmpDirectory, "eplite_import_" + randNum + ".htm");
+      destFile = path.join(tmpDirectory, "etherpad_import_" + randNum + ".htm");
 
       // Logic for allowing external Import Plugins
       hooks.aCallAll("import", {srcFile: srcFile, destFile: destFile}, function(err, result){