IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-29 12:14:08 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'externalPlugin' of https://github.com/raintank/grafana into external-plugins

Browse Source
This commit is contained in:
Torkel Ödegaard 2015-11-19 11:05:27 +01:00
commit b21fa2daa0
10 changed files with 213 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pkg/api/api.go
View File

@ -187,5 +187,7 @@ func Register(r *macaron.Macaron) {
// rendering
r.Get("/render/*", reqSignedIn, RenderToPng)
InitExternalPluginRoutes(r)
r.NotFound(NotFoundHandler)
}

74
pkg/api/externalplugin.go Normal file
View File

@ -0,0 +1,74 @@
package api
import (
"encoding/json"
"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) {
/*
// Handle Auth and role requirements
if route.ReqSignedIn {
c.Invoke(middleware.Auth(&middleware.AuthOptions{ReqSignedIn: true}))
}
if route.ReqGrafanaAdmin {
c.Invoke(middleware.Auth(&middleware.AuthOptions{ReqSignedIn: true, ReqGrafanaAdmin: true}))
}
if route.ReqRole != nil {
if *route.ReqRole == m.ROLE_EDITOR {
c.Invoke(middleware.RoleAuth(m.ROLE_EDITOR, m.ROLE_ADMIN))
}
if *route.ReqRole == m.ROLE_ADMIN {
c.Invoke(middleware.RoleAuth(m.ROLE_ADMIN))
}
}
*/
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))
}
}
}
func ExternalPlugin(routeUrl string) macaron.Handler {
return func(c *middleware.Context) {
path := c.Params("*")
//Create a HTTP header with the context in it.
ctx, err := json.Marshal(c.SignedInUser)
if err != nil {
c.JsonApiErr(500, "failed to marshal context to json.", err)
return
}
targetUrl, _ := url.Parse(routeUrl)
proxy := NewExternalPluginProxy(string(ctx), path, targetUrl)
proxy.Transport = dataProxyTransport
proxy.ServeHTTP(c.RW(), c.Req.Request)
}
}
func NewExternalPluginProxy(ctx string, proxyPath string, targetUrl *url.URL) *httputil.ReverseProxy {
director := func(req *http.Request) {
req.URL.Scheme = targetUrl.Scheme
req.URL.Host = targetUrl.Host
req.Host = targetUrl.Host
req.URL.Path = util.JoinUrlFragments(targetUrl.Path, proxyPath)
// clear cookie headers
req.Header.Del("Cookie")
req.Header.Del("Set-Cookie")
req.Header.Add("Grafana-Context", ctx)
}
return &httputil.ReverseProxy{Director: director}
}

20
pkg/api/index.go
View File

@ -3,6 +3,7 @@ package api
import (
"github.com/grafana/grafana/pkg/api/dtos"
"github.com/grafana/grafana/pkg/middleware"
"github.com/grafana/grafana/pkg/plugins"
"github.com/grafana/grafana/pkg/setting"
)
@ -52,6 +53,25 @@ func setIndexViewData(c *middleware.Context) error {
c.Data["GoogleTagManagerId"] = setting.GoogleTagManagerId
}
externalPluginJs := make([]string, 0)
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 _, css := range plugin.Settings.Css {
externalPluginCss = append(externalPluginCss, css.Href)
}
for _, item := range plugin.Settings.MenuItems {
externalPluginMenu = append(externalPluginMenu, item)
}
}
c.Data["ExternalPluginJs"] = externalPluginJs
c.Data["ExternalPluginCss"] = externalPluginCss
c.Data["ExternalPluginMenu"] = externalPluginMenu
return nil
}

48
pkg/plugins/plugins.go
View File

@ -8,6 +8,7 @@ import (
"path/filepath"
"github.com/grafana/grafana/pkg/log"
"github.com/grafana/grafana/pkg/models"
"github.com/grafana/grafana/pkg/setting"
)
@ -16,8 +17,44 @@ type PluginMeta struct {
Name string `json:"name"`
}
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"`
Url string `json:"url"`
}
type ExternalPluginJs struct {
Src string `json:"src"`
}
type ExternalPluginMenuItem struct {
Text string `json:"text"`
Icon string `json:"icon"`
Href string `json:"href"`
}
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"`
}
var (
DataSources map[string]interface{}
DataSources map[string]interface{}
ExternalPlugins []ExternalPlugin
)
type PluginScanner struct {
@ -31,6 +68,7 @@ func Init() {
func scan(pluginDir string) error {
DataSources = make(map[string]interface{})
ExternalPlugins = make([]ExternalPlugin, 0)
scanner := &PluginScanner{
pluginPath: pluginDir,
@ -93,6 +131,14 @@ func (scanner *PluginScanner) loadPluginJson(path string) error {
}
DataSources[datasourceType.(string)] = pluginJson
}
if pluginType == "externalPlugin" {
p := ExternalPlugin{}
reader.Seek(0, 0)
if err := jsonParser.Decode(&p); err != nil {
return err
}
ExternalPlugins = append(ExternalPlugins, p)
}
return nil
}

4
public/app/app.js
View File

@ -35,6 +35,8 @@ function (angular, $, _, appLevelRequire) {
} else {
_.extend(module, register_fns);
}
// push it into the apps dependencies
apps_deps.push(module.name);
return module;
};
@ -64,8 +66,6 @@ function (angular, $, _, appLevelRequire) {
var module_name = 'grafana.'+type;
// create the module
app.useModule(angular.module(module_name, []));
// push it into the apps dependencies
apps_deps.push(module_name);
});
var preBootRequires = [

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

@ -28,6 +28,18 @@ function (angular, _, $, coreModule, config) {
href: $scope.getUrl("/datasources"),
});
}
if (_.isArray(window.externalPlugins.MainLinks)) {
_.forEach(window.externalPlugins.MainLinks, function(item) {
if (!item.adminOnly || contextSrv.hasRole('Admin')) {
$scope.mainLinks.push({
text: item.text,
icon: item.icon,
href: $scope.getUrl(item.href)
});
}
});
}
};
$scope.loadOrgs = function() {

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',

3
public/app/plugins/externalPlugins/example/README.TXT Normal file
View File

@ -0,0 +1,3 @@
Example app is available at https://github.com/raintank/grafana-plugin-example
To use, download the example app from github and run it (requires python Flask). Then rename the "_plugin.json" file in this director to "plugin.json" and restart Grafana.

41
public/app/plugins/externalPlugins/example/_plugin.json Normal file
View File

@ -0,0 +1,41 @@
{
"pluginType": "externalPlugin",
"settings": {
"routes": [
{
"path": "/example/static/*",
"method": "*",
"req_signed_in": false,
"req_grafana_admin": false,
"req_role": "Admin",
"url": "http://localhost:5000/static"
},
{
"path": "/example/api/*",
"method": "*",
"req_signed_in": true,
"req_grafana_admin": false,
"req_role": "Admin",
"url": "http://localhost:5000/api"
}
],
"css": [
{
"href": "/example/static/css/example.css"
}
],
"js": [
{
"src": "/example/static/js/app.js"
}
],
"menu_items": [
{
"text": "Example Plugin",
"icon": "fa fa-fw fa-smile-o",
"href": "/example/servers",
"adminOnly": false,
}
]
}
}

13
public/views/index.html
View File

@ -13,6 +13,9 @@
[[else]]
<link rel="stylesheet" href="[[.AppSubUrl]]/css/grafana.dark.min.css">
[[end]]
[[ range $css := .ExternalPluginCss ]]
<link rel="stylesheet" href="[[$.AppSubUrl]]/plugins[[ $css ]]">
[[ end ]]
<link rel="icon" type="image/png" href="[[.AppSubUrl]]/img/fav32.png">
<base href="[[.AppSubUrl]]/" />
@ -52,11 +55,17 @@
settings: [[.Settings]],
};
window.externalPlugins = {
MainLinks: [[.ExternalPluginMenu]]
};
require(['app/app'], function (app) {
app.boot();
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(){