IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

feat(external plugins): worked on supporting external plugins better

Browse Source
This commit is contained in:
Torkel Ödegaard 2015-11-19 18:44:07 +01:00
parent 65a7fa320a
commit 69daede583
13 changed files with 58 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
pkg/api/externalplugin.go
View File

@ -2,14 +2,15 @@ package api
import (
"encoding/json"
"net/http"
"net/http/httputil"
"net/url"
"github.com/Unknwon/macaron"
"github.com/grafana/grafana/pkg/log"
"github.com/grafana/grafana/pkg/middleware"
"github.com/grafana/grafana/pkg/plugins"
"github.com/grafana/grafana/pkg/util"
"net/http"
"net/http/httputil"
"net/url"
)
func InitExternalPluginRoutes(r *macaron.Macaron) {
@ -31,10 +32,10 @@ func InitExternalPluginRoutes(r *macaron.Macaron) {
}
*/
for _, plugin := range plugins.ExternalPlugins {
log.Info("adding routes for external plugin")
for _, route := range plugin.Settings.Routes {
log.Info("adding route %s /plugins%s", route.Method, route.Path)
r.Route(util.JoinUrlFragments("/plugins/", route.Path), route.Method, ExternalPlugin(route.Url))
log.Info("Plugin: Adding proxy routes for backend plugin")
for _, route := range plugin.Routes {
log.Info("Plugin: Adding route %s /api/plugin-proxy/%s", route.Method, route.Path)
r.Route(util.JoinUrlFragments("/api/plugin-proxy/", route.Path), route.Method, ExternalPlugin(route.Url))
}
}
}

9
pkg/api/index.go
View File

@ -57,16 +57,15 @@ func setIndexViewData(c *middleware.Context) error {
externalPluginCss := make([]string, 0)
externalPluginMenu := make([]*plugins.ExternalPluginMenuItem, 0)
for _, plugin := range plugins.ExternalPlugins {
for _, js := range plugin.Settings.Js {
externalPluginJs = append(externalPluginJs, js.Src)
for _, js := range plugin.Js {
externalPluginJs = append(externalPluginJs, js.Module)
}
for _, css := range plugin.Settings.Css {
for _, css := range plugin.Css {
externalPluginCss = append(externalPluginCss, css.Href)
}
for _, item := range plugin.Settings.MenuItems {
for _, item := range plugin.MenuItems {
externalPluginMenu = append(externalPluginMenu, item)
}
}
c.Data["ExternalPluginJs"] = externalPluginJs
c.Data["ExternalPluginCss"] = externalPluginCss

11
pkg/cmd/web.go
View File

@ -29,6 +29,12 @@ func newMacaron() *macaron.Macaron {
m.Use(middleware.Gziper())
}
for _, route := range plugins.StaticRoutes {
pluginRoute := path.Join("/public/plugins/", route.Url)
log.Info("Plugin: Adding static route %s -> %s", pluginRoute, route.Path)
mapStatic(m, route.Path, "", pluginRoute)
}
mapStatic(m, setting.StaticRootPath, "", "public")
mapStatic(m, setting.StaticRootPath, "app", "app")
mapStatic(m, setting.StaticRootPath, "css", "css")
@ -36,11 +42,6 @@ func newMacaron() *macaron.Macaron {
mapStatic(m, setting.StaticRootPath, "fonts", "fonts")
mapStatic(m, setting.StaticRootPath, "robots.txt", "robots.txt")
for _, route := range plugins.StaticRoutes {
log.Info("Adding plugin static route %s -> %s", route.Url, route.Path)
mapStatic(m, route.Path, "", route.Url)
}
m.Use(macaron.Renderer(macaron.RenderOptions{
Directory: path.Join(setting.StaticRootPath, "views"),
IndentJSON: macaron.Env != macaron.PROD,

27
pkg/plugins/models.go
View File

@ -16,22 +16,21 @@ type DataSourcePlugin struct {
}
type StaticRootConfig struct {
Url string `json:"url"`
Path string `json:"path"`
PluginRoot string `json:"-"`
Url string `json:"url"`
Path string `json:"path"`
}
type ExternalPluginRoute struct {
Path string `json:"path"`
Method string `json:"method"`
ReqSignedIn bool `json:"req_signed_in"`
ReqGrafanaAdmin bool `json:"req_grafana_admin"`
ReqRole models.RoleType `json:"req_role"`
ReqSignedIn bool `json:"reqSignedIn"`
ReqGrafanaAdmin bool `json:"reqGrafanaAdmin"`
ReqRole models.RoleType `json:"reqRole"`
Url string `json:"url"`
}
type ExternalPluginJs struct {
Src string `json:"src"`
Module string `json:"module"`
}
type ExternalPluginMenuItem struct {
@ -44,14 +43,10 @@ type ExternalPluginCss struct {
Href string `json:"href"`
}
type ExternalPluginSettings struct {
Routes []*ExternalPluginRoute `json:"routes"`
Js []*ExternalPluginJs `json:"js"`
Css []*ExternalPluginCss `json:"css"`
MenuItems []*ExternalPluginMenuItem `json:"menu_items"`
}
type ExternalPlugin struct {
PluginType string `json:"pluginType"`
Settings ExternalPluginSettings `json:"settings"`
Routes []*ExternalPluginRoute `json:"routes"`
Js []*ExternalPluginJs `json:"js"`
Css []*ExternalPluginCss `json:"css"`
MenuItems []*ExternalPluginMenuItem `json:"menuItems"`
StaticRootConfig *StaticRootConfig `json:"staticRoot"`
}

18
pkg/plugins/plugins.go
View File

@ -38,7 +38,7 @@ func checkExternalPluginPaths() error {
if strings.HasPrefix(section.Name(), "plugin.") {
path := section.Key("path").String()
if path != "" {
log.Info("Plugin: scaning specific dir %s", path)
log.Info("Plugin: Scaning dir %s", path)
scan(path)
}
}
@ -81,6 +81,13 @@ func (scanner *PluginScanner) walker(currentPath string, f os.FileInfo, err erro
return nil
}
func addStaticRoot(staticRootConfig *StaticRootConfig, currentDir string) {
if staticRootConfig != nil {
staticRootConfig.Path = path.Join(currentDir, staticRootConfig.Path)
StaticRoutes = append(StaticRoutes, staticRootConfig)
}
}
func (scanner *PluginScanner) loadPluginJson(pluginJsonFilePath string) error {
currentDir := filepath.Dir(pluginJsonFilePath)
reader, err := os.Open(pluginJsonFilePath)
@ -114,20 +121,17 @@ func (scanner *PluginScanner) loadPluginJson(pluginJsonFilePath string) error {
}
DataSources[p.Type] = p
if p.StaticRootConfig != nil {
p.StaticRootConfig.Path = path.Join(currentDir, p.StaticRootConfig.Path)
StaticRoutes = append(StaticRoutes, p.StaticRootConfig)
}
addStaticRoot(p.StaticRootConfig, currentDir)
}
if pluginType == "externalPlugin" {
if pluginType == "external" {
p := ExternalPlugin{}
reader.Seek(0, 0)
if err := jsonParser.Decode(&p); err != nil {
return err
}
ExternalPlugins = append(ExternalPlugins, p)
addStaticRoot(p.StaticRootConfig, currentDir)
}
return nil

10
public/app/app.js
View File

@ -68,9 +68,13 @@ function (angular, $, _, appLevelRequire) {
app.useModule(angular.module(module_name, []));
});
var preBootRequires = [
'app/features/all',
];
var preBootRequires = ['app/features/all'];
var pluginModules = window.grafanaBootData.pluginModules || [];
// add plugin modules
for (var i = 0; i < pluginModules.length; i++) {
preBootRequires.push(pluginModules[i]);
}
app.boot = function() {
require(preBootRequires, function () {

4
public/app/core/controllers/sidemenu_ctrl.js
View File

@ -29,8 +29,8 @@ function (angular, _, $, coreModule, config) {
});
}
if (_.isArray(window.externalPlugins.MainLinks)) {
_.forEach(window.externalPlugins.MainLinks, function(item) {
if (_.isArray(window.externalPlugins.mainLinks)) {
_.forEach(window.externalPlugins.mainLinks, function(item) {
if (!item.adminOnly || contextSrv.hasRole('Admin')) {
$scope.mainLinks.push({
text: item.text,

2
public/app/core/routes/all.js
View File

@ -10,7 +10,7 @@ define([
$locationProvider.html5Mode(true);
var loadOrgBundle = new BundleLoader.BundleLoader('app/features/org/all');
console.log("adding grafana routes");
$routeProvider
.when('/', {
templateUrl: 'app/partials/dashboard.html',

1
public/app/core/settings.js
View File

@ -16,7 +16,6 @@ function (_) {
'dashlist': { path: 'app/panels/dashlist', name: 'Dashboard list' },
},
new_panel_title: 'Panel Title',
plugins: {},
playlist_timespan: "1m",
unsaved_changes_warning: true,
appSubUrl: ""

7
public/app/plugins/externalPlugins/example/_plugin.json
View File

@ -37,11 +37,6 @@
"adminOnly": false,
}
]
},
"staticRoot": {
"url": "_plugins/test_ds",
"path": "public"
},
}
}

2
public/app/require_config.js
View File

@ -3,8 +3,6 @@ require.config({
baseUrl: 'public',
paths: {
'_plugins': '../_plugins',
'lodash-src': 'vendor/lodash',
lodash: 'app/core/lodash_extended',

2
public/test/test-main.js
View File

@ -95,6 +95,8 @@ function file2moduleName(filePath) {
.replace(/\.\w*$/, '');
}
window.grafanaBootData = {};
require([
'lodash',
'angular',

10
public/views/index.html
View File

@ -13,8 +13,9 @@
[[else]]
<link rel="stylesheet" href="[[.AppSubUrl]]/css/grafana.dark.min.css">
[[end]]
[[ range $css := .ExternalPluginCss ]]
<link rel="stylesheet" href="[[$.AppSubUrl]]/plugins[[ $css ]]">
<link rel="stylesheet" href="[[$.AppSubUrl]]/[[ $css ]]">
[[ end ]]
<link rel="icon" type="image/png" href="[[.AppSubUrl]]/img/fav32.png">
@ -53,19 +54,18 @@
window.grafanaBootData = {
user:[[.User]],
settings: [[.Settings]],
pluginModules: [[.ExternalPluginJs]],
};
window.externalPlugins = {
MainLinks: [[.ExternalPluginMenu]]
mainLinks: [[.ExternalPluginMenu]]
};
require(['app/app'], function (app) {
app.boot();
})
</script>
[[ range $js := .ExternalPluginJs]]
<script src="[[$.AppSubUrl]]/plugins[[ $js ]]"></script>
[[ end ]]
[[if .GoogleAnalyticsId]]
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){