plugins.ts 5.5 KB
Newer Older
E
Eugene Pankov 已提交
1
import * as fs from 'mz/fs'
E
.  
Eugene Pankov 已提交
2
import * as path from 'path'
E
lint  
Eugene Pankov 已提交
3 4
const nodeModule = require('module')
const nodeRequire = (global as any).require
E
.  
Eugene Pankov 已提交
5

E
.  
Eugene Pankov 已提交
6 7
declare function delay (ms: number): Promise<void>

E
.  
Eugene Pankov 已提交
8 9 10 11 12 13 14
function normalizePath (path: string): string {
    const cygwinPrefix = '/cygdrive/'
    if (path.startsWith(cygwinPrefix)) {
        path = path.substring(cygwinPrefix.length).replace('/', '\\')
        path = path[0] + ':' + path.substring(1)
    }
    return path
E
lint  
Eugene Pankov 已提交
15
}
E
.  
Eugene Pankov 已提交
16

E
lint  
Eugene Pankov 已提交
17
nodeRequire.main.paths.map(x => nodeModule.globalPaths.push(normalizePath(x)))
E
.  
Eugene Pankov 已提交
18

E
Eugene Pankov 已提交
19
if (process.env.TERMINUS_DEV) {
E
.  
Eugene Pankov 已提交
20 21 22
    nodeModule.globalPaths.unshift(path.dirname(require('electron').remote.app.getAppPath()))
}

E
Eugene Pankov 已提交
23
const builtinPluginsPath = process.env.TERMINUS_DEV ? path.dirname(require('electron').remote.app.getAppPath()) : path.join((process as any).resourcesPath, 'builtin-plugins')
E
wip  
Eugene Pankov 已提交
24 25

const userPluginsPath = path.join(
E
.  
Eugene Pankov 已提交
26 27 28
    require('electron').remote.app.getPath('appData'),
    'terminus',
    'plugins',
E
wip  
Eugene Pankov 已提交
29 30 31 32
)

Object.assign(window, { builtinPluginsPath, userPluginsPath })
nodeModule.globalPaths.unshift(builtinPluginsPath)
E
.  
Eugene Pankov 已提交
33
nodeModule.globalPaths.unshift(path.join(userPluginsPath, 'node_modules'))
E
wip  
Eugene Pankov 已提交
34
// nodeModule.globalPaths.unshift(path.join((process as any).resourcesPath, 'app.asar', 'node_modules'))
E
.  
Eugene Pankov 已提交
35
if (process.env.TERMINUS_PLUGINS) {
E
wip  
Eugene Pankov 已提交
36
    process.env.TERMINUS_PLUGINS.split(':').map(x => nodeModule.globalPaths.push(normalizePath(x)))
E
.  
Eugene Pankov 已提交
37 38
}

E
.  
Eugene Pankov 已提交
39 40
export declare type ProgressCallback = (current, total) => void

E
wip  
Eugene Pankov 已提交
41
export interface IPluginInfo {
E
.  
Eugene Pankov 已提交
42
    name: string
E
wip  
Eugene Pankov 已提交
43 44 45 46
    description: string
    packageName: string
    isBuiltin: boolean
    version: string
E
Eugene Pankov 已提交
47
    author: string
E
wip  
Eugene Pankov 已提交
48 49 50
    homepage?: string
    path?: string
    info?: any
E
.  
Eugene Pankov 已提交
51 52
}

E
wip  
Eugene Pankov 已提交
53 54 55 56 57 58 59 60 61
const builtinModules = [
    '@angular/animations',
    '@angular/common',
    '@angular/compiler',
    '@angular/core',
    '@angular/forms',
    '@angular/platform-browser',
    '@angular/platform-browser-dynamic',
    '@ng-bootstrap/ng-bootstrap',
E
Eugene Pankov 已提交
62
    'ngx-toastr',
E
wip  
Eugene Pankov 已提交
63
    'rxjs',
E
Eugene Pankov 已提交
64
    'rxjs/operators',
E
wip  
Eugene Pankov 已提交
65 66 67 68 69 70
    'terminus-core',
    'terminus-settings',
    'terminus-terminal',
    'zone.js/dist/zone.js',
]

71 72 73 74 75 76 77 78 79 80 81 82 83
const cachedBuiltinModules = {}
builtinModules.forEach(m => {
    cachedBuiltinModules[m] = nodeRequire(m)
})

const originalRequire = nodeRequire('module').prototype.require
nodeRequire('module').prototype.require = function (query) {
    if (cachedBuiltinModules[query]) {
        return cachedBuiltinModules[query]
    }
    return originalRequire.apply(this, arguments)
}

E
wip  
Eugene Pankov 已提交
84
export async function findPlugins (): Promise<IPluginInfo[]> {
E
.  
Eugene Pankov 已提交
85
    let paths = nodeModule.globalPaths
E
wip  
Eugene Pankov 已提交
86
    let foundPlugins: IPluginInfo[] = []
E
Eugene Pankov 已提交
87
    let candidateLocations: { pluginDir: string, packageName: string }[] = []
E
.  
Eugene Pankov 已提交
88

E
.  
Eugene Pankov 已提交
89
    for (let pluginDir of paths) {
E
.  
Eugene Pankov 已提交
90
        pluginDir = normalizePath(pluginDir)
E
.  
Eugene Pankov 已提交
91 92 93
        if (!await fs.exists(pluginDir)) {
            continue
        }
E
.  
Eugene Pankov 已提交
94
        let pluginNames = await fs.readdir(pluginDir)
E
wip  
Eugene Pankov 已提交
95 96 97
        if (await fs.exists(path.join(pluginDir, 'package.json'))) {
            candidateLocations.push({
                pluginDir: path.dirname(pluginDir),
E
Eugene Pankov 已提交
98
                packageName: path.basename(pluginDir)
E
wip  
Eugene Pankov 已提交
99 100
            })
        }
E
Eugene Pankov 已提交
101 102
        for (let packageName of pluginNames) {
            candidateLocations.push({ pluginDir, packageName })
E
wip  
Eugene Pankov 已提交
103 104
        }
    }
E
.  
Eugene Pankov 已提交
105

E
Eugene Pankov 已提交
106 107
    for (let { pluginDir, packageName } of candidateLocations) {
        let pluginPath = path.join(pluginDir, packageName)
E
wip  
Eugene Pankov 已提交
108 109 110 111 112
        let infoPath = path.join(pluginPath, 'package.json')
        if (!await fs.exists(infoPath)) {
            continue
        }

E
Eugene Pankov 已提交
113 114 115 116 117
        let name = packageName.substring('terminus-'.length)

        if (foundPlugins.some(x => x.name === name)) {
            console.info(`Plugin ${packageName} already exists, overriding`)
            foundPlugins = foundPlugins.filter(x => x.name !== name)
E
wip  
Eugene Pankov 已提交
118
        }
E
.  
Eugene Pankov 已提交
119

E
wip  
Eugene Pankov 已提交
120
        try {
E
lint  
Eugene Pankov 已提交
121
            let info = JSON.parse(await fs.readFile(infoPath, { encoding: 'utf-8' }))
E
Eugene Pankov 已提交
122
            if (!info.keywords || !(info.keywords.includes('terminus-plugin') || info.keywords.includes('terminus-builtin-plugin'))) {
E
wip  
Eugene Pankov 已提交
123
                continue
E
.  
Eugene Pankov 已提交
124
            }
E
Eugene Pankov 已提交
125 126
            let author = info.author
            author = author.name || author
E
wip  
Eugene Pankov 已提交
127
            foundPlugins.push({
E
Eugene Pankov 已提交
128 129
                name: name,
                packageName: packageName,
E
wip  
Eugene Pankov 已提交
130 131 132
                isBuiltin: pluginDir === builtinPluginsPath,
                version: info.version,
                description: info.description,
E
Eugene Pankov 已提交
133
                author,
E
wip  
Eugene Pankov 已提交
134 135 136 137
                path: pluginPath,
                info,
            })
        } catch (error) {
E
Eugene Pankov 已提交
138
            console.error('Cannot load package info for', packageName)
E
.  
Eugene Pankov 已提交
139
        }
E
.  
Eugene Pankov 已提交
140
    }
E
.  
Eugene Pankov 已提交
141

E
wip  
Eugene Pankov 已提交
142
    (window as any).installedPlugins = foundPlugins
E
.  
Eugene Pankov 已提交
143 144 145
    return foundPlugins
}

E
wip  
Eugene Pankov 已提交
146
export async function loadPlugins (foundPlugins: IPluginInfo[], progress: ProgressCallback): Promise<any[]> {
E
.  
Eugene Pankov 已提交
147 148
    let plugins: any[] = []
    progress(0, 1)
E
.  
Eugene Pankov 已提交
149 150
    let index = 0
    for (let foundPlugin of foundPlugins) {
E
lint  
Eugene Pankov 已提交
151
        console.info(`Loading ${foundPlugin.name}: ${nodeRequire.resolve(foundPlugin.path)}`)
E
.  
Eugene Pankov 已提交
152 153
        progress(index, foundPlugins.length)
        try {
E
Eugene Pankov 已提交
154 155 156 157
            let packageModule = nodeRequire(foundPlugin.path)
            let pluginModule = packageModule.default.forRoot ? packageModule.default.forRoot() : packageModule.default
            pluginModule['pluginName'] = foundPlugin.name
            pluginModule['bootstrap'] = packageModule.bootstrap
E
.  
Eugene Pankov 已提交
158 159 160 161
            plugins.push(pluginModule)
        } catch (error) {
            console.error(`Could not load ${foundPlugin.name}:`, error)
        }
E
.  
Eugene Pankov 已提交
162 163 164
        await delay(1)
        index++
    }
E
.  
Eugene Pankov 已提交
165
    progress(1, 1)
E
.  
Eugene Pankov 已提交
166 167
    return plugins
}