main.js

const latex = require('node-latex-pdf');
const rs = require('randomstring');
const mdpdf = require('mdpdf');
const fsx = require('fs-extra');
const fh = require("filehound");
const path = require('path');
const fs = require('fs');
const os = require('os');

const latex_engine = require('./lib/docogen-latex-engine');
const md_engine = require('./lib/docogen-md-engine');
const gviz = require('./lib/docogen-graphviz');
const utils = require('./lib/docogen-util');

const docogen = {};

docogen.generate_latexpdf = function(src,dest,options,cb){
    // find our file extension name
    const files = fh.create().paths(src).ext('docogen').find((err,files) => {
        if(err)
            cb(1,"error");
        else{
            // strip all test file in node_modules
            for(var index=0;;index++){
                if(files[index] == undefined) break;
                if(files[index].indexOf('node_modules') != -1){
                    files.splice(index,1);
                    index--;
                }
            }
            // doing the work without merging
            if(files.length <= 1){
                // get file name 
                let fname = '';
                if(os.type() == "Windows_NT"){
                    fname = files[0].split('\\').splice(-1)[0].split('.')[0];
                }
                else{
                    // Linux
                    fname = files[0].split('/').splice(-1)[0].split('.')[0];
                }
                // using defined output filename or not 
                let output = `${options.output}.tex` || `${rs.generate(5)}-${fname}.tex`;
                fs.writeFileSync(`${os.tmpdir()}/${output}`,latex_engine.trans2latex(JSON.parse(fs.readFileSync(files[0],'utf-8'))));
                // convert to latex pdf 
                latex(`${os.tmpdir()}/${output}`,dest,(err,pdfPath) => {
                    if(err)
                        cb(1,"latex error");
                    else
                        cb(0,`[Docogen] Job done. ${src} successfully convert into latex pdf format in ${pdfPath}`);
                })
            }
            else{
                // multiple docogen files merging
                // using defined output filename or not 
                let output = `${options.output}.tex` || `${rs.generate(5)}-merginglatex.tex`;
                // merging
                fs.writeFileSync(`${os.tmpdir()}/${output}`,latex_engine.trans2latex(this.merge_docogen(files)));
                // convert to latex pdf 
                latex(`${os.tmpdir()}/${output}`,dest,(err,pdfPath) => {
                    if(err)
                        cb(1,"latex error");
                    else
                        cb(0,`[Docogen - Merging process] Job done. ${src} successfully convert into latex pdf format in ${pdfPath}`);
                })
            }
        }
    });
}

docogen.generate_latexpdf_raw = function(md_path,options,cb){
    let output = `${options.output}.tex` || `${rs.generate(5)}-${fname}.tex`,
        dest = `${options.dest}` || __dirname;
    // Standardlize the path with \ or /
    md_path = this.path_standardlize(md_path)
    let rawjsonObj = this.md2docogen(md_path);
    rawjsonObj = this.resolve_rel(rawjsonObj,md_path);
    fs.writeFileSync(`${os.tmpdir()}/${output}`,latex_engine.trans2latex(rawjsonObj))
    // convert to latex pdf
    latex(`${os.tmpdir}/${output}`,dest,(err,pdfPath) => {
        if(err)
        cb(1,"latex error");
    else
        cb(0,`[Docogen - Merging process from rawjsonObj] Job done. JSONObj successfully convert into latex pdf format in ${pdfPath}`);
    })
}

docogen.generate_mdpdf = function(src,dest,options,cb){
    // find our file extension
    const files = fh.create().paths(src).ext('docogen').find((err,files) => {
        if(err)
            cb(1,"error");
        else{
            // strip all test file in node_modules
            for(var index in files){
                if(files[index].indexOf('node_modules') != -1){
                    files.splice(index,1);
                }
            }
            if(files.length <= 1){
                // get file name 
                let fname = '';
                if(os.type() == "Windows_NT"){
                    fname = files[0].split('\\').splice(-1)[0].split('.')[0];
                }
                else{
                    // Linux
                    fname = files[0].split('/').splice(-1)[0].split('.')[0];
                }
                // using defined output filename or not 
                let output = `${options.output}.pdf` || `${rs.generate(5)}-${fname}.pdf`;
                fs.writeFileSync(os.tmpdir()+'/'+output+'.md',md_engine.trans2md(JSON.parse(fs.readFileSync(files[0],'utf-8'))));
                let opt = {
                    source: os.tmpdir()+'/'+output+'.md',
                    destination: path.join(dest,output),
                    pdf: {
                        format: 'A4',
                        header: {
                            height: 0
                        }
                    }
                };
                // converting
                mdpdf.convert(opt).then((pdfPath) => {
                    cb(0,`[Docogen] Job done. ${src} successfully convert into markdown pdf format in ${pdfPath}`);
                }).catch((err) => {
                    cb(1,`[Docogen] Job failed.`);
                });
            }
            else{
                // multiple docogen files merging
                // using defined output filename or not 
                let output = `${options.output}.pdf` || `${rs.generate(5)}-mergingmd.pdf`;
                fs.writeFileSync(os.tmpdir()+'/'+output+'.md',md_engine.trans2md(this.merge_docogen(files)));
                let opt = {
                    source: os.tmpdir()+'/'+output+'.md',
                    destination: path.join(dest,output),
                    pdf: {
                        format: 'A4',
                        header: {
                            height: 0
                        }
                    }
                };
                // converting
                mdpdf.convert(opt).then((pdfPath) => {
                    cb(0,`[Docogen - Merging process] Job done. ${src} successfully convert into markdown pdf format in ${pdfPath}`);
                }).catch((err) => {
                    cb(1,`[Docogen] Job failed.`);
                });
            }
        }
    });
}

docogen.merge_docogen = function(src_arr,options){
    // here comes the files list
    let jsobj = {};
    console.log("Have " + src_arr.length + " files.");
    let opt = options || false;
    if(opt.detail){
        console.dir(src_arr); // print out all the files name
    }
    // Support "article","reference" part merging
    for(var index in src_arr){
        var tmp = JSON.parse(fs.readFileSync(src_arr[index],'utf-8'));
        // ============ set title (only one time) ============
        if(tmp.title != undefined && jsobj.title == undefined){
            jsobj.title = tmp.title;
        }
        // ============ set options (only one time) ============
        if(tmp.options != undefined && jsobj.options == undefined){
            jsobj.options = tmp.options;
        }
        // ============ set author (only one time) ============
        if(tmp.author != undefined && jsobj.author == undefined){
            jsobj.author = tmp.author;
        }
        // ============ set abstract (only one time) ============
        if(tmp.abstract != undefined && jsobj.abstract == undefined){
            jsobj.abstract = tmp.abstract;
        }
        // ============ merge article ============
        if(tmp.article != undefined && jsobj.article == undefined){
            src_arr[index] = this.path_standardlize(src_arr[index])
            // Resolving the path
            tmp = this.resolve_rel(tmp,src_arr[index])
            // first time setting
            jsobj.article = tmp.article;
        }
        else if( tmp.article != undefined && jsobj.article.length >= 1 ){
            src_arr[index] = this.path_standardlize(src_arr[index])
            // Resolving the path
            tmp = this.resolve_rel(tmp,src_arr[index])
            // concat then sort , by priority 
            jsobj.article = jsobj.article.concat(tmp.article);
            // sort by prority 
            jsobj.article.sort(function(a,b){
                return (a.priority - b.priority);
            });
        }
        // ============ merge reference ============
        if( tmp.reference != undefined ){
            if( jsobj.reference == undefined ) jsobj.reference = tmp.reference;
            else {
                // just concat 
                jsobj.reference = jsobj.reference.concat(tmp.reference);
            }
        }
    }
    // return result jsObj
    return jsobj;
}

// Promise version of merge_docogen
docogen.merge_docogen_promise = function(src_arr,options){
    return new Promise( (resolve,reject) => {
        // here comes the files list
        let jsobj = {};
        console.log("Have " + src_arr.length + " files.");
        let opt = options || false;
        if(opt.detail){
            console.dir(src_arr); // print out all the files name
        }
        // Support "article","reference" part merging
        for(var index in src_arr){
            // that file script with working space is src_arr[index] -> here is the key to trans relative to absolutive
            var tmp = JSON.parse(fs.readFileSync(src_arr[index],'utf-8'));
            // ============ set title (only one time) ============
            if(tmp.title != undefined && jsobj.title == undefined){
                jsobj.title = tmp.title;
            }
            // ============ set options (only one time) ============
            if(tmp.options != undefined && jsobj.options == undefined){
                jsobj.options = tmp.options;
            }
            // ============ set author (only one time) ============
            if(tmp.author != undefined && jsobj.author == undefined){
                jsobj.author = tmp.author;
            }
            // ============ set abstract (only one time) ============
            if(tmp.abstract != undefined && jsobj.abstract == undefined){
                jsobj.abstract = tmp.abstract;
            }
            // ============ merge article ============
            if(tmp.article != undefined && jsobj.article == undefined){
                // find figure & get translate to absolute
                src_arr[index] = this.path_standardlize(src_arr[index])
                // Resolving the path
                tmp = this.resolve_rel(tmp,src_arr[index])
                // first time setting
                jsobj.article = tmp.article;
            }
            else if( tmp.article != undefined && jsobj.article.length >= 1 ){
                // standardize
                src_arr[index] = this.path_standardlize(src_arr[index])
                // Resolving the path
                tmp = this.resolve_rel(tmp,src_arr[index])
                // concat then sort , by priority 
                jsobj.article = jsobj.article.concat(tmp.article);
                // sort by prority 
                jsobj.article.sort(function(a,b){
                    return (a.priority - b.priority);
                });
            }
            // ============ merge reference ============
            if( tmp.reference != undefined ){
                if( jsobj.reference == undefined ) jsobj.reference = tmp.reference;
                else {
                    // just concat 
                    jsobj.reference = jsobj.reference.concat(tmp.reference);
                }
            }
        }
        // return result jsObj
        return resolve({
            msg: "success",
            obj: jsobj
        });
    })
}

docogen.resolve_rel = function(jsObj,dirname){
    console.log("Resolving Raw path:" + dirname)
    // resolving the path from rel to abs
    if(os.type() == "Windows_NT"){
        jsObj.article = utils.resolve(jsObj.article,dirname.substring(0,dirname.lastIndexOf('\\')));
    }
    else if(os.type() == "Linux"){
        // Linux
        jsObj.article = utils.resolve(jsObj.article,dirname.substring(0,dirname.lastIndexOf('/')));     
    }
    else{
        // FIXME: Other platform, currently use linux 
        jsObj.article = utils.resolve(jsObj.article,dirname.substring(0,dirname.lastIndexOf('/')));          
    }
    return jsObj
}

// 
docogen.path_standardlize = function(dirname){
    // resolving the path from rel to abs
    if(os.type() == "Windows_NT"){
        dirname = dirname.replace(/\//g,'\\')
    }
    else if(os.type() == "Linux"){
        // Linux (if you use Window path, and then change into Linux form)
        dirname = dirname.replace(/\\/g,'/')
    }
    else{
        // FIXME: Other platform, currently use linux 
        dirname = dirname.replace(/\\/g,'/')       
    }
    return dirname
}

docogen.merge_docogen_ex = function(src_path,options,cb){
    // passing the src project dir path (do the same thing as merg_docogen)
    const files = fh.create().paths(src_path).ext('docogen').find((err,files) => {
        if(err)
            cb(1,"error");
        else{
            // strip all test file in node_modules
            for(var index in files){
                if(files[index].indexOf('node_modules') != -1){
                    files.splice(index,1);
                }
            }
            // and then pass to merge_docogen, return an docogen format json object
            cb(0,this.merge_docogen(files,options)); 
        }
    });
}

// Promise version of merge_docogen
docogen.merge_docogen_ex_promise = function(src_path,options){
    return new Promise((resolve,reject) => {
        const files = fh.create().paths(src_path).ext('docogen').find((err,files) => {
            if(err)
                reject("[Merging Process] Searching files error");
            else{
                // strip all test file in node_modules
                for(var index in files){
                    if(files[index].indexOf('node_modules') != -1){
                        files.splice(index,1);
                    }
                }
                // and then pass to merge_docogen, return an docogen format json object
                resolve({
                    msg: "[Merging Process] Merging success",
                    obj: this.merge_docogen(files,options)
                }) 
            }
        });
    })
}

// Utils exports
docogen.utils = utils;

// Graphviz exports
docogen.gviz = gviz;

// Export for markdown engine
docogen.md2docogen = md_engine.md2docogen;

module.exports = docogen;